xref: /sqlite-3.40.0/src/sqliteInt.h (revision 5f968436)
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*5f968436Sdrh ** @(#) $Id: sqliteInt.h,v 1.217 2004/02/21 19:02:30 drh Exp $
1575897234Sdrh */
1658f391b3Sdrh #include "config.h"
1775897234Sdrh #include "sqlite.h"
18beae3194Sdrh #include "hash.h"
1975897234Sdrh #include "parse.h"
20be0072d2Sdrh #include "btree.h"
2175897234Sdrh #include <stdio.h>
2275897234Sdrh #include <stdlib.h>
2375897234Sdrh #include <string.h>
2475897234Sdrh #include <assert.h>
2575897234Sdrh 
26967e8b73Sdrh /*
27a1b351afSdrh ** The maximum number of in-memory pages to use for the main database
28a1b351afSdrh ** table and for temporary tables.
29a1b351afSdrh */
30603240cfSdrh #define MAX_PAGES   2000
31603240cfSdrh #define TEMP_PAGES   500
32a1b351afSdrh 
33a1b351afSdrh /*
340bd1f4eaSdrh ** If the following macro is set to 1, then NULL values are considered
350bd1f4eaSdrh ** distinct for the SELECT DISTINCT statement and for UNION or EXCEPT
360bd1f4eaSdrh ** compound queries.  No other SQL database engine (among those tested)
370bd1f4eaSdrh ** works this way except for OCELOT.  But the SQL92 spec implies that
380bd1f4eaSdrh ** this is how things should work.
390bd1f4eaSdrh **
400bd1f4eaSdrh ** If the following macro is set to 0, then NULLs are indistinct for
410bd1f4eaSdrh ** SELECT DISTINCT and for UNION.
420bd1f4eaSdrh */
430bd1f4eaSdrh #define NULL_ALWAYS_DISTINCT 0
440bd1f4eaSdrh 
450bd1f4eaSdrh /*
460bd1f4eaSdrh ** If the following macro is set to 1, then NULL values are considered
470bd1f4eaSdrh ** distinct when determining whether or not two entries are the same
480bd1f4eaSdrh ** in a UNIQUE index.  This is the way PostgreSQL, Oracle, DB2, MySQL,
490bd1f4eaSdrh ** OCELOT, and Firebird all work.  The SQL92 spec explicitly says this
500bd1f4eaSdrh ** is the way things are suppose to work.
510bd1f4eaSdrh **
520bd1f4eaSdrh ** If the following macro is set to 0, the NULLs are indistinct for
530bd1f4eaSdrh ** a UNIQUE index.  In this mode, you can only have a single NULL entry
540bd1f4eaSdrh ** for a column declared UNIQUE.  This is the way Informix and SQL Server
550bd1f4eaSdrh ** work.
560bd1f4eaSdrh */
570bd1f4eaSdrh #define NULL_DISTINCT_FOR_UNIQUE 1
580bd1f4eaSdrh 
590bd1f4eaSdrh /*
60665de47aSdrh ** The maximum number of attached databases.  This must be at least 2
61665de47aSdrh ** in order to support the main database file (0) and the file used to
62a3643a26Sjplyon ** hold temporary tables (1).  And it must be less than 256 because
63665de47aSdrh ** an unsigned character is used to stored the database index.
64665de47aSdrh */
65665de47aSdrh #define MAX_ATTACHED 10
66665de47aSdrh 
67665de47aSdrh /*
6813bff815Sdrh ** The next macro is used to determine where TEMP tables and indices
6913bff815Sdrh ** are stored.  Possible values:
7013bff815Sdrh **
7113bff815Sdrh **   0    Always use a temporary files
7213bff815Sdrh **   1    Use a file unless overridden by "PRAGMA temp_store"
7313bff815Sdrh **   2    Use memory unless overridden by "PRAGMA temp_store"
7413bff815Sdrh **   3    Always use memory
7513bff815Sdrh */
7613bff815Sdrh #ifndef TEMP_STORE
7713bff815Sdrh # define TEMP_STORE 1
7813bff815Sdrh #endif
7913bff815Sdrh 
8013bff815Sdrh /*
8113bff815Sdrh ** When building SQLite for embedded systems where memory is scarce,
8213bff815Sdrh ** you can define one or more of the following macros to omit extra
8313bff815Sdrh ** features of the library and thus keep the size of the library to
8413bff815Sdrh ** a minimum.
8513bff815Sdrh */
8613bff815Sdrh /* #define SQLITE_OMIT_AUTHORIZATION  1 */
8770ce3f0cSdrh /* #define SQLITE_OMIT_INMEMORYDB     1 */
8813bff815Sdrh /* #define SQLITE_OMIT_VACUUM         1 */
890a5294bcSdrh /* #define SQLITE_OMIT_DATETIME_FUNCS 1 */
90348bb5d6Sdanielk1977 /* #define SQLITE_OMIT_PROGRESS_CALLBACK 1 */
9113bff815Sdrh 
9213bff815Sdrh /*
935a2c2c20Sdrh ** Integers of known sizes.  These typedefs might change for architectures
945a2c2c20Sdrh ** where the sizes very.  Preprocessor macros are available so that the
955a2c2c20Sdrh ** types can be conveniently redefined at compile-type.  Like this:
965a2c2c20Sdrh **
975a2c2c20Sdrh **         cc '-DUINTPTR_TYPE=long long int' ...
9841a2b48bSdrh */
995a2c2c20Sdrh #ifndef UINT32_TYPE
1005a2c2c20Sdrh # define UINT32_TYPE unsigned int
1015a2c2c20Sdrh #endif
1025a2c2c20Sdrh #ifndef UINT16_TYPE
1035a2c2c20Sdrh # define UINT16_TYPE unsigned short int
1045a2c2c20Sdrh #endif
1055a2c2c20Sdrh #ifndef UINT8_TYPE
1065a2c2c20Sdrh # define UINT8_TYPE unsigned char
1075a2c2c20Sdrh #endif
108905793e2Sdrh #ifndef INT8_TYPE
109905793e2Sdrh # define INT8_TYPE signed char
110905793e2Sdrh #endif
1115a2c2c20Sdrh #ifndef INTPTR_TYPE
11258f391b3Sdrh # if SQLITE_PTR_SZ==4
1135a2c2c20Sdrh #   define INTPTR_TYPE int
11458f391b3Sdrh # else
11558f391b3Sdrh #   define INTPTR_TYPE long long
11658f391b3Sdrh # endif
1175a2c2c20Sdrh #endif
1185a2c2c20Sdrh typedef UINT32_TYPE u32;           /* 4-byte unsigned integer */
1195a2c2c20Sdrh typedef UINT16_TYPE u16;           /* 2-byte unsigned integer */
1205a2c2c20Sdrh typedef UINT8_TYPE u8;             /* 1-byte unsigned integer */
121905793e2Sdrh typedef UINT8_TYPE i8;             /* 1-byte signed integer */
1225a2c2c20Sdrh typedef INTPTR_TYPE ptr;           /* Big enough to hold a pointer */
1235a2c2c20Sdrh typedef unsigned INTPTR_TYPE uptr; /* Big enough to hold a pointer */
1245a2c2c20Sdrh 
1255a2c2c20Sdrh /*
126905793e2Sdrh ** Defer sourcing vdbe.h until after the "u8" typedef is defined.
127905793e2Sdrh */
128905793e2Sdrh #include "vdbe.h"
129905793e2Sdrh 
130905793e2Sdrh /*
131384eef32Sdrh ** Most C compilers these days recognize "long double", don't they?
132384eef32Sdrh ** Just in case we encounter one that does not, we will create a macro
133384eef32Sdrh ** for long double so that it can be easily changed to just "double".
134384eef32Sdrh */
135384eef32Sdrh #ifndef LONGDOUBLE_TYPE
136384eef32Sdrh # define LONGDOUBLE_TYPE long double
137384eef32Sdrh #endif
138384eef32Sdrh 
139384eef32Sdrh /*
1405a2c2c20Sdrh ** This macro casts a pointer to an integer.  Useful for doing
1415a2c2c20Sdrh ** pointer arithmetic.
1425a2c2c20Sdrh */
1435a2c2c20Sdrh #define Addr(X)  ((uptr)X)
14441a2b48bSdrh 
14541a2b48bSdrh /*
146872ff86fSdrh ** The maximum number of bytes of data that can be put into a single
14780ff32f5Sdrh ** row of a single table.  The upper bound on this limit is 16777215
14880ff32f5Sdrh ** bytes (or 16MB-1).  We have arbitrarily set the limit to just 1MB
14980ff32f5Sdrh ** here because the overflow page chain is inefficient for really big
15080ff32f5Sdrh ** records and we want to discourage people from thinking that
15180ff32f5Sdrh ** multi-megabyte records are OK.  If your needs are different, you can
15280ff32f5Sdrh ** change this define and recompile to increase or decrease the record
15380ff32f5Sdrh ** size.
1549ac717d7Sdrh **
1559ac717d7Sdrh ** The 16777198 is computed as follows:  238 bytes of payload on the
1569ac717d7Sdrh ** original pages plus 16448 overflow pages each holding 1020 bytes of
1579ac717d7Sdrh ** data.
158872ff86fSdrh */
1598372b8d1Sdrh #define MAX_BYTES_PER_ROW  1048576
1608372b8d1Sdrh /* #define MAX_BYTES_PER_ROW 16777198 */
161872ff86fSdrh 
162872ff86fSdrh /*
163967e8b73Sdrh ** If memory allocation problems are found, recompile with
164967e8b73Sdrh **
165967e8b73Sdrh **      -DMEMORY_DEBUG=1
166967e8b73Sdrh **
167967e8b73Sdrh ** to enable some sanity checking on malloc() and free().  To
168967e8b73Sdrh ** check for memory leaks, recompile with
169967e8b73Sdrh **
170967e8b73Sdrh **      -DMEMORY_DEBUG=2
171967e8b73Sdrh **
172967e8b73Sdrh ** and a line of text will be written to standard error for
173967e8b73Sdrh ** each malloc() and free().  This output can be analyzed
174967e8b73Sdrh ** by an AWK script to determine if there are any leaks.
175967e8b73Sdrh */
176dcc581ccSdrh #ifdef MEMORY_DEBUG
1778c1238aeSdrh # define sqliteMalloc(X)    sqliteMalloc_(X,1,__FILE__,__LINE__)
1788c1238aeSdrh # define sqliteMallocRaw(X) sqliteMalloc_(X,0,__FILE__,__LINE__)
179dcc581ccSdrh # define sqliteFree(X)      sqliteFree_(X,__FILE__,__LINE__)
180dcc581ccSdrh # define sqliteRealloc(X,Y) sqliteRealloc_(X,Y,__FILE__,__LINE__)
1816e142f54Sdrh # define sqliteStrDup(X)    sqliteStrDup_(X,__FILE__,__LINE__)
1826e142f54Sdrh # define sqliteStrNDup(X,Y) sqliteStrNDup_(X,Y,__FILE__,__LINE__)
183c3c2fc9aSdrh   void sqliteStrRealloc(char**);
184c3c2fc9aSdrh #else
185*5f968436Sdrh # define sqliteRealloc_(X,Y) sqliteRealloc(X,Y)
186c3c2fc9aSdrh # define sqliteStrRealloc(X)
187dcc581ccSdrh #endif
188dcc581ccSdrh 
18975897234Sdrh /*
190daffd0e5Sdrh ** This variable gets set if malloc() ever fails.  After it gets set,
191daffd0e5Sdrh ** the SQLite library shuts down permanently.
192daffd0e5Sdrh */
193daffd0e5Sdrh extern int sqlite_malloc_failed;
194daffd0e5Sdrh 
195daffd0e5Sdrh /*
1966e142f54Sdrh ** The following global variables are used for testing and debugging
1978c82b350Sdrh ** only.  They only work if MEMORY_DEBUG is defined.
1986e142f54Sdrh */
1996e142f54Sdrh #ifdef MEMORY_DEBUG
2008c82b350Sdrh extern int sqlite_nMalloc;       /* Number of sqliteMalloc() calls */
2018c82b350Sdrh extern int sqlite_nFree;         /* Number of sqliteFree() calls */
2028c82b350Sdrh extern int sqlite_iMallocFail;   /* Fail sqliteMalloc() after this many calls */
2036e142f54Sdrh #endif
2046e142f54Sdrh 
2056e142f54Sdrh /*
20675897234Sdrh ** Name of the master database table.  The master database table
20775897234Sdrh ** is a special table that holds the names and attributes of all
20875897234Sdrh ** user tables and indices.
20975897234Sdrh */
21075897234Sdrh #define MASTER_NAME       "sqlite_master"
211e0bc4048Sdrh #define TEMP_MASTER_NAME  "sqlite_temp_master"
21275897234Sdrh 
21375897234Sdrh /*
214ed6c8671Sdrh ** The name of the schema table.
215ed6c8671Sdrh */
216ed6c8671Sdrh #define SCHEMA_TABLE(x)  (x?TEMP_MASTER_NAME:MASTER_NAME)
217ed6c8671Sdrh 
218ed6c8671Sdrh /*
21975897234Sdrh ** A convenience macro that returns the number of elements in
22075897234Sdrh ** an array.
22175897234Sdrh */
22275897234Sdrh #define ArraySize(X)    (sizeof(X)/sizeof(X[0]))
22375897234Sdrh 
22475897234Sdrh /*
22575897234Sdrh ** Forward references to structures
22675897234Sdrh */
2277020f651Sdrh typedef struct Column Column;
22875897234Sdrh typedef struct Table Table;
22975897234Sdrh typedef struct Index Index;
23075897234Sdrh typedef struct Instruction Instruction;
23175897234Sdrh typedef struct Expr Expr;
23275897234Sdrh typedef struct ExprList ExprList;
23375897234Sdrh typedef struct Parse Parse;
23475897234Sdrh typedef struct Token Token;
23575897234Sdrh typedef struct IdList IdList;
236ad3cab52Sdrh typedef struct SrcList SrcList;
23775897234Sdrh typedef struct WhereInfo WhereInfo;
2386b56344dSdrh typedef struct WhereLevel WhereLevel;
2399bb61fe7Sdrh typedef struct Select Select;
2402282792aSdrh typedef struct AggExpr AggExpr;
2410bce8354Sdrh typedef struct FuncDef FuncDef;
242c3f9bad2Sdanielk1977 typedef struct Trigger Trigger;
243c3f9bad2Sdanielk1977 typedef struct TriggerStep TriggerStep;
244c3f9bad2Sdanielk1977 typedef struct TriggerStack TriggerStack;
245c2eef3b3Sdrh typedef struct FKey FKey;
246001bbcbbSdrh typedef struct Db Db;
24785e2096fSdrh typedef struct AuthContext AuthContext;
248001bbcbbSdrh 
249001bbcbbSdrh /*
250001bbcbbSdrh ** Each database file to be accessed by the system is an instance
251001bbcbbSdrh ** of the following structure.  There are normally two of these structures
252001bbcbbSdrh ** in the sqlite.aDb[] array.  aDb[0] is the main database file and
253a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables.  Additional
254a69d9168Sdrh ** databases may be attached.
255001bbcbbSdrh */
256001bbcbbSdrh struct Db {
257001bbcbbSdrh   char *zName;         /* Name of this database */
258001bbcbbSdrh   Btree *pBt;          /* The B*Tree structure for this database file */
259001bbcbbSdrh   int schema_cookie;   /* Database schema version number for this file */
260d24cc427Sdrh   Hash tblHash;        /* All tables indexed by name */
261d24cc427Sdrh   Hash idxHash;        /* All (named) indices indexed by name */
262d24cc427Sdrh   Hash trigHash;       /* All triggers indexed by name */
263d24cc427Sdrh   Hash aFKey;          /* Foreign keys indexed by to-table */
2641aa4965aSdrh   u8 inTrans;          /* 0: not writable.  1: Transaction.  2: Checkpoint */
265d24cc427Sdrh   u16 flags;           /* Flags associated with this database */
2664d189ca4Sdrh   void *pAux;          /* Auxiliary data.  Usually NULL */
2674d189ca4Sdrh   void (*xFreeAux)(void*);  /* Routine to free pAux */
268001bbcbbSdrh };
26975897234Sdrh 
27075897234Sdrh /*
2718bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the
2728bf8dc92Sdrh ** Db.flags field.
2738bf8dc92Sdrh */
2748bf8dc92Sdrh #define DbHasProperty(D,I,P)     (((D)->aDb[I].flags&(P))==(P))
2758bf8dc92Sdrh #define DbHasAnyProperty(D,I,P)  (((D)->aDb[I].flags&(P))!=0)
2768bf8dc92Sdrh #define DbSetProperty(D,I,P)     (D)->aDb[I].flags|=(P)
2778bf8dc92Sdrh #define DbClearProperty(D,I,P)   (D)->aDb[I].flags&=~(P)
2788bf8dc92Sdrh 
2798bf8dc92Sdrh /*
2808bf8dc92Sdrh ** Allowed values for the DB.flags field.
2818bf8dc92Sdrh **
2828bf8dc92Sdrh ** The DB_Locked flag is set when the first OP_Transaction or OP_Checkpoint
2838bf8dc92Sdrh ** opcode is emitted for a database.  This prevents multiple occurances
2848bf8dc92Sdrh ** of those opcodes for the same database in the same program.  Similarly,
2858bf8dc92Sdrh ** the DB_Cookie flag is set when the OP_VerifyCookie opcode is emitted,
2868bf8dc92Sdrh ** and prevents duplicate OP_VerifyCookies from taking up space and slowing
2878bf8dc92Sdrh ** down execution.
2888bf8dc92Sdrh **
2898bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been
2908bf8dc92Sdrh ** read into internal hash tables.
2918bf8dc92Sdrh **
2928bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that
2938bf8dc92Sdrh ** have been filled out.  If the schema changes, these column names might
2948bf8dc92Sdrh ** changes and so the view will need to be reset.
2958bf8dc92Sdrh */
2968bf8dc92Sdrh #define DB_Locked          0x0001  /* OP_Transaction opcode has been emitted */
2978bf8dc92Sdrh #define DB_Cookie          0x0002  /* OP_VerifyCookie opcode has been emiited */
2988bf8dc92Sdrh #define DB_SchemaLoaded    0x0004  /* The schema has been loaded */
2998bf8dc92Sdrh #define DB_UnresetViews    0x0008  /* Some views have defined column names */
3008bf8dc92Sdrh 
3018bf8dc92Sdrh 
3028bf8dc92Sdrh /*
303c9b84a1fSdrh ** Each database is an instance of the following structure.
304c9b84a1fSdrh **
305c9b84a1fSdrh ** The sqlite.file_format is initialized by the database file
306c9b84a1fSdrh ** and helps determines how the data in the database file is
307c9b84a1fSdrh ** represented.  This field allows newer versions of the library
308c9b84a1fSdrh ** to read and write older databases.  The various file formats
309c9b84a1fSdrh ** are as follows:
310c9b84a1fSdrh **
311c9b84a1fSdrh **     file_format==1    Version 2.1.0.
312c9b84a1fSdrh **     file_format==2    Version 2.2.0. Add support for INTEGER PRIMARY KEY.
313491791a8Sdrh **     file_format==3    Version 2.6.0. Fix empty-string index bug.
314491791a8Sdrh **     file_format==4    Version 2.7.0. Add support for separate numeric and
315c9b84a1fSdrh **                       text datatypes.
31613bff815Sdrh **
31713bff815Sdrh ** The sqlite.temp_store determines where temporary database files
31813bff815Sdrh ** are stored.  If 1, then a file is created to hold those tables.  If
31913bff815Sdrh ** 2, then they are held in memory.  0 means use the default value in
32013bff815Sdrh ** the TEMP_STORE macro.
321b0c374ffSrdc **
322b0c374ffSrdc ** The sqlite.lastRowid records the last insert rowid generated by an
323b0c374ffSrdc ** insert statement.  Inserts on views do not affect its value.  Each
324b0c374ffSrdc ** trigger has its own context, so that lastRowid can be updated inside
325b0c374ffSrdc ** triggers as usual.  The previous value will be restored once the trigger
326b0c374ffSrdc ** exits.  Upon entering a before or instead of trigger, lastRowid is no
327b0c374ffSrdc ** longer (since after version 2.8.12) reset to -1.
328b0c374ffSrdc **
329b0c374ffSrdc ** The sqlite.nChange does not count changes within triggers and keeps no
330b0c374ffSrdc ** context.  It is reset at start of sqlite_exec.
331b0c374ffSrdc ** The sqlite.lsChange represents the number of changes made by the last
332b0c374ffSrdc ** insert, update, or delete statement.  It remains constant throughout the
333b0c374ffSrdc ** length of a statement and is then updated by OP_SetCounts.  It keeps a
334b0c374ffSrdc ** context stack just like lastRowid so that the count of changes
335b0c374ffSrdc ** within a trigger is not seen outside the trigger.  Changes to views do not
336b0c374ffSrdc ** affect the value of lsChange.
337b0c374ffSrdc ** The sqlite.csChange keeps track of the number of current changes (since
338b0c374ffSrdc ** the last statement) and is used to update sqlite_lsChange.
33975897234Sdrh */
34075897234Sdrh struct sqlite {
341001bbcbbSdrh   int nDb;                      /* Number of backends currently in use */
342001bbcbbSdrh   Db *aDb;                      /* All backends */
343001bbcbbSdrh   Db aDbStatic[2];              /* Static space for the 2 default backends */
3448c82b350Sdrh   int flags;                    /* Miscellanous flags. See below */
345973b6e33Sdrh   u8 file_format;               /* What file format version is this database? */
346973b6e33Sdrh   u8 safety_level;              /* How aggressive at synching data to disk */
34794e92032Sdrh   u8 want_to_close;             /* Close after all VDBEs are deallocated */
3481d85d931Sdrh   u8 temp_store;                /* 1=file, 2=memory, 0=compile-time default */
3491d85d931Sdrh   u8 onError;                   /* Default conflict algorithm */
350001bbcbbSdrh   int next_cookie;              /* Next value of aDb[0].schema_cookie */
351cd61c281Sdrh   int cache_size;               /* Number of pages to use in the cache */
3522803757aSdrh   int nTable;                   /* Number of tables in the database */
3532dfbbcafSdrh   void *pBusyArg;               /* 1st Argument to the busy callback */
354353f57e0Sdrh   int (*xBusyCallback)(void *,const char*,int);  /* The busy callback */
355aa940eacSdrh   void *pCommitArg;             /* Argument to xCommitCallback() */
356aa940eacSdrh   int (*xCommitCallback)(void*);/* Invoked at every commit. */
3570bce8354Sdrh   Hash aFunc;                   /* All functions that can be in SQL exprs */
358b0c374ffSrdc   int lastRowid;                /* ROWID of most recent insert (see above) */
3595cf8e8c7Sdrh   int priorNewRowid;            /* Last randomly generated ROWID */
360247be43dSdrh   int magic;                    /* Magic number for detect library misuse */
361b0c374ffSrdc   int nChange;                  /* Number of rows changed (see above) */
362b0c374ffSrdc   int lsChange;                 /* Last statement change count (see above) */
363b0c374ffSrdc   int csChange;                 /* Current statement change count (see above) */
3641d85d931Sdrh   struct sqliteInitInfo {       /* Information used during initialization */
3651d85d931Sdrh     int iDb;                       /* When back is being initialized */
3661d85d931Sdrh     int newTnum;                   /* Rootpage of table being initialized */
3671d85d931Sdrh     u8 busy;                       /* TRUE if currently initializing */
3681d85d931Sdrh   } init;
369326dce74Sdrh   struct Vdbe *pVdbe;           /* List of active virtual machines */
37018de4824Sdrh   void (*xTrace)(void*,const char*);     /* Trace function */
37118de4824Sdrh   void *pTraceArg;                       /* Argument to the trace function */
372ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
373e22a334bSdrh   int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
374e22a334bSdrh                                 /* Access authorization function */
375ed6c8671Sdrh   void *pAuthArg;               /* 1st argument to the access auth function */
376ed6c8671Sdrh #endif
377348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
378348bb5d6Sdanielk1977   int (*xProgress)(void *);     /* The progress callback */
379348bb5d6Sdanielk1977   void *pProgressArg;           /* Argument to the progress callback */
380348bb5d6Sdanielk1977   int nProgressOps;             /* Number of opcodes for progress callback */
381348bb5d6Sdanielk1977 #endif
38275897234Sdrh };
38375897234Sdrh 
38475897234Sdrh /*
3858bf8dc92Sdrh ** Possible values for the sqlite.flags and or Db.flags fields.
3868bf8dc92Sdrh **
3878bf8dc92Sdrh ** On sqlite.flags, the SQLITE_InTrans value means that we have
3888bf8dc92Sdrh ** executed a BEGIN.  On Db.flags, SQLITE_InTrans means a statement
3898bf8dc92Sdrh ** transaction is active on that particular database file.
39075897234Sdrh */
3914c504391Sdrh #define SQLITE_VdbeTrace      0x00000001  /* True to trace VDBE execution */
3924c504391Sdrh #define SQLITE_Initialized    0x00000002  /* True after initialization */
3934c504391Sdrh #define SQLITE_Interrupt      0x00000004  /* Cancel current operation */
394c4a3c779Sdrh #define SQLITE_InTrans        0x00000008  /* True if in a transaction */
3955e00f6c7Sdrh #define SQLITE_InternChanges  0x00000010  /* Uncommitted Hash table changes */
396382c0247Sdrh #define SQLITE_FullColNames   0x00000020  /* Show full column names on SELECT */
397fcabd464Sdrh #define SQLITE_ShortColNames  0x00000040  /* Show short columns names */
398fcabd464Sdrh #define SQLITE_CountRows      0x00000080  /* Count rows changed by INSERT, */
3991bee3d7bSdrh                                           /*   DELETE, or UPDATE and return */
4001bee3d7bSdrh                                           /*   the count using a callback. */
401fcabd464Sdrh #define SQLITE_NullCallback   0x00000100  /* Invoke the callback once if the */
4026a535340Sdrh                                           /*   result set is empty */
4038bf8dc92Sdrh #define SQLITE_ReportTypes    0x00000200  /* Include information on datatypes */
4045080aaa7Sdrh                                           /*   in 4th argument of callback */
40558b9576bSdrh 
40658b9576bSdrh /*
407247be43dSdrh ** Possible values for the sqlite.magic field.
408247be43dSdrh ** The numbers are obtained at random and have no special meaning, other
409247be43dSdrh ** than being distinct from one another.
410247be43dSdrh */
411247be43dSdrh #define SQLITE_MAGIC_OPEN     0xa029a697  /* Database is open */
412247be43dSdrh #define SQLITE_MAGIC_CLOSED   0x9f3c2d33  /* Database is closed */
413247be43dSdrh #define SQLITE_MAGIC_BUSY     0xf03b7906  /* Database currently in use */
414247be43dSdrh #define SQLITE_MAGIC_ERROR    0xb5357930  /* An SQLITE_MISUSE error occurred */
415247be43dSdrh 
416247be43dSdrh /*
4170bce8354Sdrh ** Each SQL function is defined by an instance of the following
4180bce8354Sdrh ** structure.  A pointer to this structure is stored in the sqlite.aFunc
4198e0a2f90Sdrh ** hash table.  When multiple functions have the same name, the hash table
4208e0a2f90Sdrh ** points to a linked list of these structures.
4212803757aSdrh */
4220bce8354Sdrh struct FuncDef {
4231350b030Sdrh   void (*xFunc)(sqlite_func*,int,const char**);  /* Regular function */
42456c0e926Sdrh   void (*xStep)(sqlite_func*,int,const char**);  /* Aggregate function step */
4251350b030Sdrh   void (*xFinalize)(sqlite_func*);           /* Aggregate function finializer */
4268e0a2f90Sdrh   int nArg;                                  /* Number of arguments */
427c9b84a1fSdrh   int dataType;                              /* Datatype of the result */
4281350b030Sdrh   void *pUserData;                           /* User data parameter */
4290bce8354Sdrh   FuncDef *pNext;                            /* Next function with same name */
4308e0a2f90Sdrh };
4312803757aSdrh 
4322803757aSdrh /*
433967e8b73Sdrh ** information about each column of an SQL table is held in an instance
4347020f651Sdrh ** of this structure.
4357020f651Sdrh */
4367020f651Sdrh struct Column {
4377020f651Sdrh   char *zName;     /* Name of this column */
4387020f651Sdrh   char *zDflt;     /* Default value of this column */
439382c0247Sdrh   char *zType;     /* Data type for this column */
4404a32431cSdrh   u8 notNull;      /* True if there is a NOT NULL constraint */
44178100cc9Sdrh   u8 isPrimKey;    /* True if this column is part of the PRIMARY KEY */
4428e2ca029Sdrh   u8 sortOrder;    /* Some combination of SQLITE_SO_... values */
443fcabd464Sdrh   u8 dottedName;   /* True if zName contains a "." character */
4447020f651Sdrh };
4457020f651Sdrh 
4467020f651Sdrh /*
4478e2ca029Sdrh ** The allowed sort orders.
4488e2ca029Sdrh **
4498e2ca029Sdrh ** The TEXT and NUM values use bits that do not overlap with DESC and ASC.
4508e2ca029Sdrh ** That way the two can be combined into a single number.
4518e2ca029Sdrh */
4528e2ca029Sdrh #define SQLITE_SO_UNK       0  /* Use the default collating type.  (SCT_NUM) */
4538e2ca029Sdrh #define SQLITE_SO_TEXT      2  /* Sort using memcmp() */
4548e2ca029Sdrh #define SQLITE_SO_NUM       4  /* Sort using sqliteCompare() */
4558e2ca029Sdrh #define SQLITE_SO_TYPEMASK  6  /* Mask to extract the collating sequence */
4568e2ca029Sdrh #define SQLITE_SO_ASC       0  /* Sort in ascending order */
4578e2ca029Sdrh #define SQLITE_SO_DESC      1  /* Sort in descending order */
4588e2ca029Sdrh #define SQLITE_SO_DIRMASK   1  /* Mask to extract the sort direction */
4598e2ca029Sdrh 
4608e2ca029Sdrh /*
46122f70c32Sdrh ** Each SQL table is represented in memory by an instance of the
46222f70c32Sdrh ** following structure.
46322f70c32Sdrh **
464d24cc427Sdrh ** Table.zName is the name of the table.  The case of the original
46522f70c32Sdrh ** CREATE TABLE statement is stored, but case is not significant for
46622f70c32Sdrh ** comparisons.
46722f70c32Sdrh **
468d24cc427Sdrh ** Table.nCol is the number of columns in this table.  Table.aCol is a
46922f70c32Sdrh ** pointer to an array of Column structures, one for each column.
47022f70c32Sdrh **
471d24cc427Sdrh ** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
472d24cc427Sdrh ** the column that is that key.   Otherwise Table.iPKey is negative.  Note
47322f70c32Sdrh ** that the datatype of the PRIMARY KEY must be INTEGER for this field to
47422f70c32Sdrh ** be set.  An INTEGER PRIMARY KEY is used as the rowid for each row of
47522f70c32Sdrh ** the table.  If a table has no INTEGER PRIMARY KEY, then a random rowid
476d24cc427Sdrh ** is generated for each row of the table.  Table.hasPrimKey is true if
47722f70c32Sdrh ** the table has any PRIMARY KEY, INTEGER or otherwise.
47822f70c32Sdrh **
479d24cc427Sdrh ** Table.tnum is the page number for the root BTree page of the table in the
480d24cc427Sdrh ** database file.  If Table.iDb is the index of the database table backend
481d24cc427Sdrh ** in sqlite.aDb[].  0 is for the main database and 1 is for the file that
482d24cc427Sdrh ** holds temporary tables and indices.  If Table.isTransient
48322f70c32Sdrh ** is true, then the table is stored in a file that is automatically deleted
484d24cc427Sdrh ** when the VDBE cursor to the table is closed.  In this case Table.tnum
48522f70c32Sdrh ** refers VDBE cursor number that holds the table open, not to the root
48622f70c32Sdrh ** page number.  Transient tables are used to hold the results of a
48722f70c32Sdrh ** sub-query that appears instead of a real table name in the FROM clause
48822f70c32Sdrh ** of a SELECT statement.
48975897234Sdrh */
49075897234Sdrh struct Table {
49175897234Sdrh   char *zName;     /* Name of the table */
49275897234Sdrh   int nCol;        /* Number of columns in this table */
4937020f651Sdrh   Column *aCol;    /* Information about each column */
494c8392586Sdrh   int iPKey;       /* If not less then 0, use aCol[iPKey] as the primary key */
495967e8b73Sdrh   Index *pIndex;   /* List of SQL indexes on this table. */
49622f70c32Sdrh   int tnum;        /* Root BTree node for this table (see note above) */
497a76b5dfcSdrh   Select *pSelect; /* NULL for tables.  Points to definition if a view. */
498717e6402Sdrh   u8 readOnly;     /* True if this table should not be written by the user */
499d24cc427Sdrh   u8 iDb;          /* Index into sqlite.aDb[] of the backend for this table */
50022f70c32Sdrh   u8 isTransient;  /* True if automatically deleted when VDBE finishes */
5014a32431cSdrh   u8 hasPrimKey;   /* True if there exists a primary key */
5029cfcf5d4Sdrh   u8 keyConf;      /* What to do in case of uniqueness conflict on iPKey */
503c3f9bad2Sdanielk1977   Trigger *pTrigger; /* List of SQL triggers on this table */
504c2eef3b3Sdrh   FKey *pFKey;       /* Linked list of all foreign keys in this table */
50575897234Sdrh };
50675897234Sdrh 
50775897234Sdrh /*
508c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure.
509c2eef3b3Sdrh **
510c2eef3b3Sdrh ** A foreign key is associated with two tables.  The "from" table is
511c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign
512c2eef3b3Sdrh ** key.  The "to" table is the table that is named in the REFERENCES clause.
513c2eef3b3Sdrh ** Consider this example:
514c2eef3b3Sdrh **
515c2eef3b3Sdrh **     CREATE TABLE ex1(
516c2eef3b3Sdrh **       a INTEGER PRIMARY KEY,
517c2eef3b3Sdrh **       b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
518c2eef3b3Sdrh **     );
519c2eef3b3Sdrh **
520c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
521c2eef3b3Sdrh **
522c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure
523c2eef3b3Sdrh ** which is attached to the from-table.  The to-table need not exist when
524c2eef3b3Sdrh ** the from-table is created.  The existance of the to-table is not checked
525c2eef3b3Sdrh ** until an attempt is made to insert data into the from-table.
526c2eef3b3Sdrh **
527ea1ba17cSdrh ** The sqlite.aFKey hash table stores pointers to this structure
528c2eef3b3Sdrh ** given the name of a to-table.  For each to-table, all foreign keys
529c2eef3b3Sdrh ** associated with that table are on a linked list using the FKey.pNextTo
530c2eef3b3Sdrh ** field.
531c2eef3b3Sdrh */
532c2eef3b3Sdrh struct FKey {
533c2eef3b3Sdrh   Table *pFrom;     /* The table that constains the REFERENCES clause */
534c2eef3b3Sdrh   FKey *pNextFrom;  /* Next foreign key in pFrom */
535c2eef3b3Sdrh   char *zTo;        /* Name of table that the key points to */
536c2eef3b3Sdrh   FKey *pNextTo;    /* Next foreign key that points to zTo */
537c2eef3b3Sdrh   int nCol;         /* Number of columns in this key */
538c2eef3b3Sdrh   struct sColMap {  /* Mapping of columns in pFrom to columns in zTo */
539c2eef3b3Sdrh     int iFrom;         /* Index of column in pFrom */
540c2eef3b3Sdrh     char *zCol;        /* Name of column in zTo.  If 0 use PRIMARY KEY */
541c2eef3b3Sdrh   } *aCol;          /* One entry for each of nCol column s */
542c2eef3b3Sdrh   u8 isDeferred;    /* True if constraint checking is deferred till COMMIT */
543c2eef3b3Sdrh   u8 updateConf;    /* How to resolve conflicts that occur on UPDATE */
544c2eef3b3Sdrh   u8 deleteConf;    /* How to resolve conflicts that occur on DELETE */
545c2eef3b3Sdrh   u8 insertConf;    /* How to resolve conflicts that occur on INSERT */
546c2eef3b3Sdrh };
547c2eef3b3Sdrh 
548c2eef3b3Sdrh /*
549c2eef3b3Sdrh ** SQLite supports many different ways to resolve a contraint
55022f70c32Sdrh ** error.  ROLLBACK processing means that a constraint violation
5510bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction
5521c92853dSdrh ** to be rolled back.  ABORT processing means the operation in process
5531c92853dSdrh ** fails and any prior changes from that one operation are backed out,
5541c92853dSdrh ** but the transaction is not rolled back.  FAIL processing means that
5551c92853dSdrh ** the operation in progress stops and returns an error code.  But prior
5561c92853dSdrh ** changes due to the same operation are not backed out and no rollback
5571c92853dSdrh ** occurs.  IGNORE means that the particular row that caused the constraint
5581c92853dSdrh ** error is not inserted or updated.  Processing continues and no error
5591c92853dSdrh ** is returned.  REPLACE means that preexisting database rows that caused
5601c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or
5611c92853dSdrh ** update can proceed.  Processing continues and no error is reported.
5621c92853dSdrh **
563c2eef3b3Sdrh ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
564c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
565c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys.  SETNULL means that the foreign
566c2eef3b3Sdrh ** key is set to NULL.  CASCADE means that a DELETE or UPDATE of the
567c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the
568c2eef3b3Sdrh ** foreign key.
569c2eef3b3Sdrh **
570968af52aSdrh ** The following symbolic values are used to record which type
5711c92853dSdrh ** of action to take.
5729cfcf5d4Sdrh */
5739cfcf5d4Sdrh #define OE_None     0   /* There is no constraint to check */
5741c92853dSdrh #define OE_Rollback 1   /* Fail the operation and rollback the transaction */
5751c92853dSdrh #define OE_Abort    2   /* Back out changes but do no rollback transaction */
5761c92853dSdrh #define OE_Fail     3   /* Stop the operation but leave all prior changes */
5771c92853dSdrh #define OE_Ignore   4   /* Ignore the error. Do not do the INSERT or UPDATE */
5781c92853dSdrh #define OE_Replace  5   /* Delete existing record, then do INSERT or UPDATE */
579c2eef3b3Sdrh 
580c2eef3b3Sdrh #define OE_Restrict 6   /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
581c2eef3b3Sdrh #define OE_SetNull  7   /* Set the foreign key value to NULL */
582c2eef3b3Sdrh #define OE_SetDflt  8   /* Set the foreign key value to its default */
583c2eef3b3Sdrh #define OE_Cascade  9   /* Cascade the changes */
584c2eef3b3Sdrh 
585c2eef3b3Sdrh #define OE_Default  99  /* Do whatever the default action is */
5869cfcf5d4Sdrh 
5879cfcf5d4Sdrh /*
58866b89c8fSdrh ** Each SQL index is represented in memory by an
58975897234Sdrh ** instance of the following structure.
590967e8b73Sdrh **
591967e8b73Sdrh ** The columns of the table that are to be indexed are described
592967e8b73Sdrh ** by the aiColumn[] field of this structure.  For example, suppose
593967e8b73Sdrh ** we have the following table and index:
594967e8b73Sdrh **
595967e8b73Sdrh **     CREATE TABLE Ex1(c1 int, c2 int, c3 text);
596967e8b73Sdrh **     CREATE INDEX Ex2 ON Ex1(c3,c1);
597967e8b73Sdrh **
598967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are
599967e8b73Sdrh ** three columns in the table.  In the Index structure describing
600967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
601967e8b73Sdrh ** The value of aiColumn is {2, 0}.  aiColumn[0]==2 because the
602967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
603967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in
604967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
605ea1ba17cSdrh **
606ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns
607ea1ba17cSdrh ** must be unique and what to do if they are not.  When Index.onError=OE_None,
608ea1ba17cSdrh ** it means this is not a unique index.  Otherwise it is a unique index
609ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution
610ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique
611ea1ba17cSdrh ** element.
61275897234Sdrh */
61375897234Sdrh struct Index {
61475897234Sdrh   char *zName;     /* Name of this index */
615967e8b73Sdrh   int nColumn;     /* Number of columns in the table used by this index */
616967e8b73Sdrh   int *aiColumn;   /* Which columns are used by this index.  1st is 0 */
617967e8b73Sdrh   Table *pTable;   /* The SQL table being indexed */
618be0072d2Sdrh   int tnum;        /* Page containing root of this index in database file */
6199cfcf5d4Sdrh   u8 onError;      /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
620485b39b4Sdrh   u8 autoIndex;    /* True if is automatically created (ex: by UNIQUE) */
621d24cc427Sdrh   u8 iDb;          /* Index in sqlite.aDb[] of where this index is stored */
62275897234Sdrh   Index *pNext;    /* The next index associated with the same table */
62375897234Sdrh };
62475897234Sdrh 
62575897234Sdrh /*
62675897234Sdrh ** Each token coming out of the lexer is an instance of
6274b59ab5eSdrh ** this structure.  Tokens are also used as part of an expression.
6284efc4754Sdrh **
6294efc4754Sdrh ** Note if Token.z==0 then Token.dyn and Token.n are undefined and
6304efc4754Sdrh ** may contain random values.  Do not make any assuptions about Token.dyn
6314efc4754Sdrh ** and Token.n when Token.z==0.
63275897234Sdrh */
63375897234Sdrh struct Token {
63480ff32f5Sdrh   const char *z;      /* Text of the token.  Not NULL-terminated! */
6354b59ab5eSdrh   unsigned dyn  : 1;  /* True for malloced memory, false for static */
6366977fea8Sdrh   unsigned n    : 31; /* Number of characters in this token */
63775897234Sdrh };
63875897234Sdrh 
63975897234Sdrh /*
64075897234Sdrh ** Each node of an expression in the parse tree is an instance
64122f70c32Sdrh ** of this structure.
64222f70c32Sdrh **
64322f70c32Sdrh ** Expr.op is the opcode.  The integer parser token codes are reused
64422f70c32Sdrh ** as opcodes here.  For example, the parser defines TK_GE to be an integer
64522f70c32Sdrh ** code representing the ">=" operator.  This same integer code is reused
64622f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression
64722f70c32Sdrh ** tree.
64822f70c32Sdrh **
64922f70c32Sdrh ** Expr.pRight and Expr.pLeft are subexpressions.  Expr.pList is a list
65022f70c32Sdrh ** of argument if the expression is a function.
65122f70c32Sdrh **
6524b59ab5eSdrh ** Expr.token is the operator token for this node.  For some expressions
6534b59ab5eSdrh ** that have subexpressions, Expr.token can be the complete text that gave
6544b59ab5eSdrh ** rise to the Expr.  In the latter case, the token is marked as being
6554b59ab5eSdrh ** a compound token.
65622f70c32Sdrh **
65722f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table.
65822f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
65922f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and
66022f70c32Sdrh ** Expr.iColumn is the column number for the specific column.  If the
66122f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the
66222f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that
66322f70c32Sdrh ** it can be accessed after all aggregates are computed.
66422f70c32Sdrh **
66522f70c32Sdrh ** If the expression is a function, the Expr.iTable is an integer code
6667c972decSdrh ** representing which function.  If the expression is an unbound variable
6677c972decSdrh ** marker (a question mark character '?' in the original SQL) then the
6687c972decSdrh ** Expr.iTable holds the index number for that variable.
66922f70c32Sdrh **
67022f70c32Sdrh ** The Expr.pSelect field points to a SELECT statement.  The SELECT might
67122f70c32Sdrh ** be the right operand of an IN operator.  Or, if a scalar SELECT appears
67222f70c32Sdrh ** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
67322f70c32Sdrh ** operand.
67475897234Sdrh */
67575897234Sdrh struct Expr {
6761cc093c2Sdrh   u8 op;                 /* Operation performed by this node */
6778e2ca029Sdrh   u8 dataType;           /* Either SQLITE_SO_TEXT or SQLITE_SO_NUM */
678b5a20d3cSdrh   u8 iDb;                /* Database referenced by this expression */
679e22a334bSdrh   u8 flags;              /* Various flags.  See below */
68075897234Sdrh   Expr *pLeft, *pRight;  /* Left and right subnodes */
681d99f7068Sdrh   ExprList *pList;       /* A list of expressions used as function arguments
682d99f7068Sdrh                          ** or in "<expr> IN (<expr-list)" */
68375897234Sdrh   Token token;           /* An operand token */
6846977fea8Sdrh   Token span;            /* Complete text of the expression */
685967e8b73Sdrh   int iTable, iColumn;   /* When op==TK_COLUMN, then this expr node means the
6868e2ca029Sdrh                          ** iColumn-th field of the iTable-th table. */
687967e8b73Sdrh   int iAgg;              /* When op==TK_COLUMN and pParse->useAgg==TRUE, pull
688967e8b73Sdrh                          ** result from the iAgg-th element of the aggregator */
689d99f7068Sdrh   Select *pSelect;       /* When the expression is a sub-select.  Also the
690d99f7068Sdrh                          ** right side of "<expr> IN (<select>)" */
69175897234Sdrh };
69275897234Sdrh 
69375897234Sdrh /*
6941f16230bSdrh ** The following are the meanings of bits in the Expr.flags field.
6951f16230bSdrh */
6961f16230bSdrh #define EP_FromJoin     0x0001  /* Originated in ON or USING clause of a join */
6971f16230bSdrh 
6981f16230bSdrh /*
6991f16230bSdrh ** These macros can be used to test, set, or clear bits in the
7001f16230bSdrh ** Expr.flags field.
7011f16230bSdrh */
7021f16230bSdrh #define ExprHasProperty(E,P)     (((E)->flags&(P))==(P))
7031f16230bSdrh #define ExprHasAnyProperty(E,P)  (((E)->flags&(P))!=0)
7041f16230bSdrh #define ExprSetProperty(E,P)     (E)->flags|=(P)
7051f16230bSdrh #define ExprClearProperty(E,P)   (E)->flags&=~(P)
7061f16230bSdrh 
7071f16230bSdrh /*
70875897234Sdrh ** A list of expressions.  Each expression may optionally have a
70975897234Sdrh ** name.  An expr/name combination can be used in several ways, such
71075897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the
71175897234Sdrh ** list of "ID = expr" items in an UPDATE.  A list of expressions can
712ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName
71375897234Sdrh ** field is not used.
71475897234Sdrh */
71575897234Sdrh struct ExprList {
71675897234Sdrh   int nExpr;             /* Number of expressions on the list */
7174305d103Sdrh   int nAlloc;            /* Number of entries allocated below */
7186d4abfbeSdrh   struct ExprList_item {
71975897234Sdrh     Expr *pExpr;           /* The list of expressions */
72075897234Sdrh     char *zName;           /* Token associated with this expression */
7218e2ca029Sdrh     u8 sortOrder;          /* 1 for DESC or 0 for ASC */
7228e2ca029Sdrh     u8 isAgg;              /* True if this is an aggregate like count(*) */
7238e2ca029Sdrh     u8 done;               /* A flag to indicate when processing is finished */
72475897234Sdrh   } *a;                  /* One entry for each expression */
72575897234Sdrh };
72675897234Sdrh 
72775897234Sdrh /*
728ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers,
729ad3cab52Sdrh ** such as the list "a,b,c" in the following statements:
730ad3cab52Sdrh **
731ad3cab52Sdrh **      INSERT INTO t(a,b,c) VALUES ...;
732ad3cab52Sdrh **      CREATE INDEX idx ON t(a,b,c);
733ad3cab52Sdrh **      CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
734ad3cab52Sdrh **
735ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of
736ad3cab52Sdrh ** column names after a table name in an INSERT statement.  In the statement
737ad3cab52Sdrh **
738ad3cab52Sdrh **     INSERT INTO t(a,b,c) ...
739ad3cab52Sdrh **
740ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
74175897234Sdrh */
74275897234Sdrh struct IdList {
74375897234Sdrh   int nId;         /* Number of identifiers on the list */
7444305d103Sdrh   int nAlloc;      /* Number of entries allocated for a[] below */
7456d4abfbeSdrh   struct IdList_item {
746ad3cab52Sdrh     char *zName;      /* Name of the identifier */
747967e8b73Sdrh     int idx;          /* Index in some Table.aCol[] of a column named zName */
748ad3cab52Sdrh   } *a;
749ad3cab52Sdrh };
750ad3cab52Sdrh 
751ad3cab52Sdrh /*
752ad3cab52Sdrh ** The following structure describes the FROM clause of a SELECT statement.
753ad3cab52Sdrh ** Each table or subquery in the FROM clause is a separate element of
754ad3cab52Sdrh ** the SrcList.a[] array.
755d24cc427Sdrh **
756d24cc427Sdrh ** With the addition of multiple database support, the following structure
757d24cc427Sdrh ** can also be used to describe a particular table such as the table that
758d24cc427Sdrh ** is modified by an INSERT, DELETE, or UPDATE statement.  In standard SQL,
759d24cc427Sdrh ** such a table must be a simple name: ID.  But in SQLite, the table can
760d24cc427Sdrh ** now be identified by a database name, a dot, then the table name: ID.ID.
761ad3cab52Sdrh */
762ad3cab52Sdrh struct SrcList {
7634305d103Sdrh   u16 nSrc;        /* Number of tables or subqueries in the FROM clause */
7644305d103Sdrh   u16 nAlloc;      /* Number of entries allocated in a[] below */
765ad3cab52Sdrh   struct SrcList_item {
766113088ecSdrh     char *zDatabase;  /* Name of database holding this table */
767ad3cab52Sdrh     char *zName;      /* Name of the table */
768ad3cab52Sdrh     char *zAlias;     /* The "B" part of a "A AS B" phrase.  zName is the "A" */
769daffd0e5Sdrh     Table *pTab;      /* An SQL table corresponding to zName */
770daffd0e5Sdrh     Select *pSelect;  /* A SELECT statement used in place of a table name */
771ad3cab52Sdrh     int jointype;     /* Type of join between this table and the next */
77263eb5f29Sdrh     int iCursor;      /* The VDBE cursor number used to access this table */
773ad3cab52Sdrh     Expr *pOn;        /* The ON clause of a join */
774ad3cab52Sdrh     IdList *pUsing;   /* The USING clause of a join */
775113088ecSdrh   } a[1];             /* One entry for each identifier on the list */
77675897234Sdrh };
77775897234Sdrh 
77875897234Sdrh /*
77901f3f253Sdrh ** Permitted values of the SrcList.a.jointype field
78001f3f253Sdrh */
78101f3f253Sdrh #define JT_INNER     0x0001    /* Any kind of inner or cross join */
78201f3f253Sdrh #define JT_NATURAL   0x0002    /* True for a "natural" join */
783195e6967Sdrh #define JT_LEFT      0x0004    /* Left outer join */
784195e6967Sdrh #define JT_RIGHT     0x0008    /* Right outer join */
78501f3f253Sdrh #define JT_OUTER     0x0010    /* The "OUTER" keyword is present */
78601f3f253Sdrh #define JT_ERROR     0x0020    /* unknown or unsupported join type */
78701f3f253Sdrh 
78801f3f253Sdrh /*
7896b56344dSdrh ** For each nested loop in a WHERE clause implementation, the WhereInfo
7906b56344dSdrh ** structure contains a single instance of this structure.  This structure
7916b56344dSdrh ** is intended to be private the the where.c module and should not be
7926b56344dSdrh ** access or modified by other modules.
7936b56344dSdrh */
7946b56344dSdrh struct WhereLevel {
7956b56344dSdrh   int iMem;            /* Memory cell used by this level */
7966b56344dSdrh   Index *pIdx;         /* Index used */
7976b56344dSdrh   int iCur;            /* Cursor number used for this index */
798487ab3caSdrh   int score;           /* How well this indexed scored */
7996b56344dSdrh   int brk;             /* Jump here to break out of the loop */
8006b56344dSdrh   int cont;            /* Jump here to continue with the next loop cycle */
8016b56344dSdrh   int op, p1, p2;      /* Opcode used to terminate the loop */
802ad2d8307Sdrh   int iLeftJoin;       /* Memory cell used to implement LEFT OUTER JOIN */
803ad2d8307Sdrh   int top;             /* First instruction of interior of the loop */
804d99f7068Sdrh   int inOp, inP1, inP2;/* Opcode used to implement an IN operator */
805c045ec51Sdrh   int bRev;            /* Do the scan in the reverse direction */
8066b56344dSdrh };
8076b56344dSdrh 
8086b56344dSdrh /*
80975897234Sdrh ** The WHERE clause processing routine has two halves.  The
81075897234Sdrh ** first part does the start of the WHERE loop and the second
81175897234Sdrh ** half does the tail of the WHERE loop.  An instance of
81275897234Sdrh ** this structure is returned by the first half and passed
81375897234Sdrh ** into the second half to give some continuity.
81475897234Sdrh */
81575897234Sdrh struct WhereInfo {
81675897234Sdrh   Parse *pParse;
817ad3cab52Sdrh   SrcList *pTabList;   /* List of tables in the join */
81819a775c2Sdrh   int iContinue;       /* Jump here to continue with next record */
81919a775c2Sdrh   int iBreak;          /* Jump here to break out of the loop */
8206b56344dSdrh   int nLevel;          /* Number of nested loop */
821832508b7Sdrh   int savedNTab;       /* Value of pParse->nTab before WhereBegin() */
822832508b7Sdrh   int peakNTab;        /* Value of pParse->nTab after WhereBegin() */
8236b56344dSdrh   WhereLevel a[1];     /* Information about each nest loop in the WHERE */
82475897234Sdrh };
82575897234Sdrh 
82675897234Sdrh /*
8279bb61fe7Sdrh ** An instance of the following structure contains all information
8289bb61fe7Sdrh ** needed to generate code for a single SELECT statement.
829a76b5dfcSdrh **
830a76b5dfcSdrh ** The zSelect field is used when the Select structure must be persistent.
831a76b5dfcSdrh ** Normally, the expression tree points to tokens in the original input
832a76b5dfcSdrh ** string that encodes the select.  But if the Select structure must live
833a76b5dfcSdrh ** longer than its input string (for example when it is used to describe
834a76b5dfcSdrh ** a VIEW) we have to make a copy of the input string so that the nodes
835a76b5dfcSdrh ** of the expression tree will have something to point to.  zSelect is used
836a76b5dfcSdrh ** to hold that copy.
837d11d382cSdrh **
838d11d382cSdrh ** nLimit is set to -1 if there is no LIMIT clause.  nOffset is set to 0.
839d11d382cSdrh ** If there is a LIMIT clause, the parser sets nLimit to the value of the
840d11d382cSdrh ** limit and nOffset to the value of the offset (or 0 if there is not
841d11d382cSdrh ** offset).  But later on, nLimit and nOffset become the memory locations
842d11d382cSdrh ** in the VDBE that record the limit and offset counters.
8439bb61fe7Sdrh */
8449bb61fe7Sdrh struct Select {
8459bb61fe7Sdrh   ExprList *pEList;      /* The fields of the result */
8467b58daeaSdrh   u8 op;                 /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
8477b58daeaSdrh   u8 isDistinct;         /* True if the DISTINCT keyword is present */
848ad3cab52Sdrh   SrcList *pSrc;         /* The FROM clause */
8499bb61fe7Sdrh   Expr *pWhere;          /* The WHERE clause */
8509bb61fe7Sdrh   ExprList *pGroupBy;    /* The GROUP BY clause */
8519bb61fe7Sdrh   Expr *pHaving;         /* The HAVING clause */
8529bb61fe7Sdrh   ExprList *pOrderBy;    /* The ORDER BY clause */
853967e8b73Sdrh   Select *pPrior;        /* Prior select in a compound select statement */
8549bbca4c1Sdrh   int nLimit, nOffset;   /* LIMIT and OFFSET values.  -1 means not used */
8557b58daeaSdrh   int iLimit, iOffset;   /* Memory registers holding LIMIT & OFFSET counters */
856a76b5dfcSdrh   char *zSelect;         /* Complete text of the SELECT command */
8579bb61fe7Sdrh };
8589bb61fe7Sdrh 
8599bb61fe7Sdrh /*
860fef5208cSdrh ** The results of a select can be distributed in several ways.
861fef5208cSdrh */
862fef5208cSdrh #define SRT_Callback     1  /* Invoke a callback with each row of result */
863fef5208cSdrh #define SRT_Mem          2  /* Store result in a memory cell */
86482c3d636Sdrh #define SRT_Set          3  /* Store result as unique keys in a table */
86582c3d636Sdrh #define SRT_Union        5  /* Store result as keys in a table */
86682c3d636Sdrh #define SRT_Except       6  /* Remove result from a UNION table */
8675974a30fSdrh #define SRT_Table        7  /* Store result as data with a unique key */
8682d0794e3Sdrh #define SRT_TempTable    8  /* Store result in a trasient table */
869d7489c39Sdrh #define SRT_Discard      9  /* Do not save the results anywhere */
870f46f905aSdrh #define SRT_Sorter      10  /* Store results in the sorter */
871142e30dfSdrh #define SRT_Subroutine  11  /* Call a subroutine to handle results */
872fef5208cSdrh 
873fef5208cSdrh /*
8742282792aSdrh ** When a SELECT uses aggregate functions (like "count(*)" or "avg(f1)")
8752282792aSdrh ** we have to do some additional analysis of expressions.  An instance
8762282792aSdrh ** of the following structure holds information about a single subexpression
8772282792aSdrh ** somewhere in the SELECT statement.  An array of these structures holds
8782282792aSdrh ** all the information we need to generate code for aggregate
8792282792aSdrh ** expressions.
8802282792aSdrh **
8812282792aSdrh ** Note that when analyzing a SELECT containing aggregates, both
8822282792aSdrh ** non-aggregate field variables and aggregate functions are stored
8832282792aSdrh ** in the AggExpr array of the Parser structure.
8842282792aSdrh **
8852282792aSdrh ** The pExpr field points to an expression that is part of either the
8862282792aSdrh ** field list, the GROUP BY clause, the HAVING clause or the ORDER BY
8872282792aSdrh ** clause.  The expression will be freed when those clauses are cleaned
8882282792aSdrh ** up.  Do not try to delete the expression attached to AggExpr.pExpr.
8892282792aSdrh **
8902282792aSdrh ** If AggExpr.pExpr==0, that means the expression is "count(*)".
8912282792aSdrh */
8922282792aSdrh struct AggExpr {
8932282792aSdrh   int isAgg;        /* if TRUE contains an aggregate function */
8942282792aSdrh   Expr *pExpr;      /* The expression */
8950bce8354Sdrh   FuncDef *pFunc;   /* Information about the aggregate function */
8962282792aSdrh };
8972282792aSdrh 
8982282792aSdrh /*
899f57b3399Sdrh ** An SQL parser context.  A copy of this structure is passed through
900f57b3399Sdrh ** the parser and down into all the parser action routine in order to
901f57b3399Sdrh ** carry around information that is global to the entire parse.
90275897234Sdrh */
90375897234Sdrh struct Parse {
90475897234Sdrh   sqlite *db;          /* The main database structure */
9054c504391Sdrh   int rc;              /* Return code from execution */
90675897234Sdrh   char *zErrMsg;       /* An error message */
90775897234Sdrh   Token sErrToken;     /* The token at which the error occurred */
90875897234Sdrh   Token sFirstToken;   /* The first token parsed */
90975897234Sdrh   Token sLastToken;    /* The last token parsed */
910326dce74Sdrh   const char *zTail;   /* All SQL text past the last semicolon parsed */
91175897234Sdrh   Table *pNewTable;    /* A table being constructed by CREATE TABLE */
91275897234Sdrh   Vdbe *pVdbe;         /* An engine for executing database bytecode */
913836faa48Sdrh   u8 colNamesSet;      /* TRUE after OP_ColumnName has been issued to pVdbe */
914e0bc4048Sdrh   u8 explain;          /* True if the EXPLAIN flag is found on the query */
915e0bc4048Sdrh   u8 nameClash;        /* A permanent table name clashes with temp table name */
916e0bc4048Sdrh   u8 useAgg;           /* If true, extract field values from the aggregator
917e0bc4048Sdrh                        ** while generating expressions.  Normally false */
91875897234Sdrh   int nErr;            /* Number of errors seen */
919832508b7Sdrh   int nTab;            /* Number of previously allocated VDBE cursors */
92019a775c2Sdrh   int nMem;            /* Number of memory cells used so far */
921fef5208cSdrh   int nSet;            /* Number of sets used so far */
9222282792aSdrh   int nAgg;            /* Number of aggregate expressions */
9237c972decSdrh   int nVar;            /* Number of '?' variables seen in the SQL so far */
9242282792aSdrh   AggExpr *aAgg;       /* An array of aggregate expressions */
9255cf590c1Sdrh   const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
926f0f258b1Sdrh   Trigger *pNewTrigger;     /* Trigger under construct by a CREATE TRIGGER */
927f0f258b1Sdrh   TriggerStack *trigStack;  /* Trigger actions being coded */
92875897234Sdrh };
92975897234Sdrh 
930d99bc930Sdanielk1977 /*
93185e2096fSdrh ** An instance of the following structure can be declared on a stack and used
93285e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later.
93385e2096fSdrh */
93485e2096fSdrh struct AuthContext {
93585e2096fSdrh   const char *zAuthContext;   /* Put saved Parse.zAuthContext here */
93685e2096fSdrh   Parse *pParse;              /* The Parse structure */
93785e2096fSdrh };
93885e2096fSdrh 
93985e2096fSdrh /*
940b0c374ffSrdc ** Bitfield flags for P2 value in OP_PutIntKey and OP_Delete
941b0c374ffSrdc */
942b0c374ffSrdc #define OPFLAG_NCHANGE   1    /* Set to update db->nChange */
943b0c374ffSrdc #define OPFLAG_LASTROWID 2    /* Set to update db->lastRowid */
944b0c374ffSrdc #define OPFLAG_CSCHANGE  4    /* Set to update db->csChange */
945b0c374ffSrdc 
946b0c374ffSrdc /*
947d99bc930Sdanielk1977  * Each trigger present in the database schema is stored as an instance of
948d99bc930Sdanielk1977  * struct Trigger.
949d99bc930Sdanielk1977  *
950d99bc930Sdanielk1977  * Pointers to instances of struct Trigger are stored in two ways.
951d99bc930Sdanielk1977  * 1. In the "trigHash" hash table (part of the sqlite* that represents the
952d99bc930Sdanielk1977  *    database). This allows Trigger structures to be retrieved by name.
953d99bc930Sdanielk1977  * 2. All triggers associated with a single table form a linked list, using the
954ad3cab52Sdrh  *    pNext member of struct Trigger. A pointer to the first element of the
955ad3cab52Sdrh  *    linked list is stored as the "pTrigger" member of the associated
956ad3cab52Sdrh  *    struct Table.
957d99bc930Sdanielk1977  *
958ad3cab52Sdrh  * The "step_list" member points to the first element of a linked list
959ad3cab52Sdrh  * containing the SQL statements specified as the trigger program.
960d99bc930Sdanielk1977  */
961d99bc930Sdanielk1977 struct Trigger {
962d99bc930Sdanielk1977   char *name;             /* The name of the trigger                        */
963d99bc930Sdanielk1977   char *table;            /* The table or view to which the trigger applies */
964f0f258b1Sdrh   u8 iDb;                 /* Database containing this trigger               */
96579a519c0Sdrh   u8 iTabDb;              /* Database containing Trigger.table              */
966f0f258b1Sdrh   u8 op;                  /* One of TK_DELETE, TK_UPDATE, TK_INSERT         */
967f0f258b1Sdrh   u8 tr_tm;               /* One of TK_BEFORE, TK_AFTER */
968d99bc930Sdanielk1977   Expr *pWhen;            /* The WHEN clause of the expresion (may be NULL) */
969d99bc930Sdanielk1977   IdList *pColumns;       /* If this is an UPDATE OF <column-list> trigger,
970d99bc930Sdanielk1977                              the <column-list> is stored here */
971d99bc930Sdanielk1977   int foreach;            /* One of TK_ROW or TK_STATEMENT */
9724312db55Sdrh   Token nameToken;        /* Token containing zName. Use during parsing only */
973d99bc930Sdanielk1977 
974d99bc930Sdanielk1977   TriggerStep *step_list; /* Link list of trigger program steps             */
975d99bc930Sdanielk1977   Trigger *pNext;         /* Next trigger associated with the table */
976c3f9bad2Sdanielk1977 };
977d99bc930Sdanielk1977 
978d99bc930Sdanielk1977 /*
979d99bc930Sdanielk1977  * An instance of struct TriggerStep is used to store a single SQL statement
980d99bc930Sdanielk1977  * that is a part of a trigger-program.
981d99bc930Sdanielk1977  *
982d99bc930Sdanielk1977  * Instances of struct TriggerStep are stored in a singly linked list (linked
983d99bc930Sdanielk1977  * using the "pNext" member) referenced by the "step_list" member of the
984d99bc930Sdanielk1977  * associated struct Trigger instance. The first element of the linked list is
985d99bc930Sdanielk1977  * the first step of the trigger-program.
986d99bc930Sdanielk1977  *
987d99bc930Sdanielk1977  * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
988d99bc930Sdanielk1977  * "SELECT" statement. The meanings of the other members is determined by the
989d99bc930Sdanielk1977  * value of "op" as follows:
990d99bc930Sdanielk1977  *
991d99bc930Sdanielk1977  * (op == TK_INSERT)
992d99bc930Sdanielk1977  * orconf    -> stores the ON CONFLICT algorithm
993d99bc930Sdanielk1977  * pSelect   -> If this is an INSERT INTO ... SELECT ... statement, then
994d99bc930Sdanielk1977  *              this stores a pointer to the SELECT statement. Otherwise NULL.
995d99bc930Sdanielk1977  * target    -> A token holding the name of the table to insert into.
996d99bc930Sdanielk1977  * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
997d99bc930Sdanielk1977  *              this stores values to be inserted. Otherwise NULL.
998d99bc930Sdanielk1977  * pIdList   -> If this is an INSERT INTO ... (<column-names>) VALUES ...
999ad3cab52Sdrh  *              statement, then this stores the column-names to be
1000ad3cab52Sdrh  *              inserted into.
1001d99bc930Sdanielk1977  *
1002d99bc930Sdanielk1977  * (op == TK_DELETE)
1003d99bc930Sdanielk1977  * target    -> A token holding the name of the table to delete from.
1004d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the DELETE statement if one is specified.
1005d99bc930Sdanielk1977  *              Otherwise NULL.
1006d99bc930Sdanielk1977  *
1007d99bc930Sdanielk1977  * (op == TK_UPDATE)
1008d99bc930Sdanielk1977  * target    -> A token holding the name of the table to update rows of.
1009d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the UPDATE statement if one is specified.
1010d99bc930Sdanielk1977  *              Otherwise NULL.
1011d99bc930Sdanielk1977  * pExprList -> A list of the columns to update and the expressions to update
1012ad3cab52Sdrh  *              them to. See sqliteUpdate() documentation of "pChanges"
1013ad3cab52Sdrh  *              argument.
1014d99bc930Sdanielk1977  *
1015d99bc930Sdanielk1977  */
1016c3f9bad2Sdanielk1977 struct TriggerStep {
1017c3f9bad2Sdanielk1977   int op;              /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1018d99bc930Sdanielk1977   int orconf;          /* OE_Rollback etc. */
1019a69d9168Sdrh   Trigger *pTrig;      /* The trigger that this step is a part of */
1020c3f9bad2Sdanielk1977 
1021c3f9bad2Sdanielk1977   Select *pSelect;     /* Valid for SELECT and sometimes
1022c3f9bad2Sdanielk1977 			  INSERT steps (when pExprList == 0) */
1023c3f9bad2Sdanielk1977   Token target;        /* Valid for DELETE, UPDATE, INSERT steps */
1024c3f9bad2Sdanielk1977   Expr *pWhere;        /* Valid for DELETE, UPDATE steps */
1025c3f9bad2Sdanielk1977   ExprList *pExprList; /* Valid for UPDATE statements and sometimes
1026c3f9bad2Sdanielk1977 			   INSERT steps (when pSelect == 0)         */
1027c3f9bad2Sdanielk1977   IdList *pIdList;     /* Valid for INSERT statements only */
1028c3f9bad2Sdanielk1977 
1029c3f9bad2Sdanielk1977   TriggerStep * pNext; /* Next in the link-list */
1030c3f9bad2Sdanielk1977 };
1031c3f9bad2Sdanielk1977 
1032d99bc930Sdanielk1977 /*
1033d99bc930Sdanielk1977  * An instance of struct TriggerStack stores information required during code
1034d99bc930Sdanielk1977  * generation of a single trigger program. While the trigger program is being
1035d99bc930Sdanielk1977  * coded, its associated TriggerStack instance is pointed to by the
1036d99bc930Sdanielk1977  * "pTriggerStack" member of the Parse structure.
1037d99bc930Sdanielk1977  *
1038d99bc930Sdanielk1977  * The pTab member points to the table that triggers are being coded on. The
1039d99bc930Sdanielk1977  * newIdx member contains the index of the vdbe cursor that points at the temp
1040d99bc930Sdanielk1977  * table that stores the new.* references. If new.* references are not valid
1041d99bc930Sdanielk1977  * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1042d99bc930Sdanielk1977  * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1043d99bc930Sdanielk1977  *
1044d99bc930Sdanielk1977  * The ON CONFLICT policy to be used for the trigger program steps is stored
1045d99bc930Sdanielk1977  * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1046d99bc930Sdanielk1977  * specified for individual triggers steps is used.
1047d99bc930Sdanielk1977  *
1048d99bc930Sdanielk1977  * struct TriggerStack has a "pNext" member, to allow linked lists to be
1049d99bc930Sdanielk1977  * constructed. When coding nested triggers (triggers fired by other triggers)
1050d99bc930Sdanielk1977  * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1051d99bc930Sdanielk1977  * pointer. Once the nested trigger has been coded, the pNext value is restored
1052d99bc930Sdanielk1977  * to the pTriggerStack member of the Parse stucture and coding of the parent
1053d99bc930Sdanielk1977  * trigger continues.
1054d99bc930Sdanielk1977  *
1055d99bc930Sdanielk1977  * Before a nested trigger is coded, the linked list pointed to by the
1056d99bc930Sdanielk1977  * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1057d99bc930Sdanielk1977  * recursively. If this condition is detected, the nested trigger is not coded.
1058d99bc930Sdanielk1977  */
1059d99bc930Sdanielk1977 struct TriggerStack {
1060d99bc930Sdanielk1977   Table *pTab;         /* Table that triggers are currently being coded on */
1061d99bc930Sdanielk1977   int newIdx;          /* Index of vdbe cursor to "new" temp table */
1062d99bc930Sdanielk1977   int oldIdx;          /* Index of vdbe cursor to "old" temp table */
1063d99bc930Sdanielk1977   int orconf;          /* Current orconf policy */
10646f34903eSdanielk1977   int ignoreJump;      /* where to jump to for a RAISE(IGNORE) */
1065e22a334bSdrh   Trigger *pTrigger;   /* The trigger currently being coded */
1066e22a334bSdrh   TriggerStack *pNext; /* Next trigger down on the trigger stack */
1067c3f9bad2Sdanielk1977 };
1068c3f9bad2Sdanielk1977 
1069d99bc930Sdanielk1977 /*
1070f26e09c8Sdrh ** The following structure contains information used by the sqliteFix...
1071f26e09c8Sdrh ** routines as they walk the parse tree to make database references
1072f26e09c8Sdrh ** explicit.
1073f26e09c8Sdrh */
1074f26e09c8Sdrh typedef struct DbFixer DbFixer;
1075f26e09c8Sdrh struct DbFixer {
1076f26e09c8Sdrh   Parse *pParse;      /* The parsing context.  Error messages written here */
1077f26e09c8Sdrh   const char *zDb;    /* Make sure all objects are contained in this database */
1078f26e09c8Sdrh   const char *zType;  /* Type of the container - used for error messages */
1079f26e09c8Sdrh   const Token *pName; /* Name of the container - used for error messages */
1080f26e09c8Sdrh };
1081f26e09c8Sdrh 
1082f26e09c8Sdrh /*
1083d99bc930Sdanielk1977  * This global flag is set for performance testing of triggers. When it is set
1084d99bc930Sdanielk1977  * SQLite will perform the overhead of building new and old trigger references
1085d99bc930Sdanielk1977  * even when no triggers exist
1086d99bc930Sdanielk1977  */
1087c3f9bad2Sdanielk1977 extern int always_code_trigger_setup;
1088c3f9bad2Sdanielk1977 
108975897234Sdrh /*
109075897234Sdrh ** Internal function prototypes
109175897234Sdrh */
109275897234Sdrh int sqliteStrICmp(const char *, const char *);
109375897234Sdrh int sqliteStrNICmp(const char *, const char *, int);
109475897234Sdrh int sqliteHashNoCase(const char *, int);
1095bb07e9a3Sdrh int sqliteIsNumber(const char*);
109675897234Sdrh int sqliteCompare(const char *, const char *);
109775897234Sdrh int sqliteSortCompare(const char *, const char *);
10989bbca4c1Sdrh void sqliteRealToSortable(double r, char *);
1099dcc581ccSdrh #ifdef MEMORY_DEBUG
11008c1238aeSdrh   void *sqliteMalloc_(int,int,char*,int);
1101dcc581ccSdrh   void sqliteFree_(void*,char*,int);
1102dcc581ccSdrh   void *sqliteRealloc_(void*,int,char*,int);
11036e142f54Sdrh   char *sqliteStrDup_(const char*,char*,int);
11046e142f54Sdrh   char *sqliteStrNDup_(const char*, int,char*,int);
1105ed6c8671Sdrh   void sqliteCheckMemory(void*,int);
1106dcc581ccSdrh #else
110775897234Sdrh   void *sqliteMalloc(int);
11088c1238aeSdrh   void *sqliteMallocRaw(int);
110975897234Sdrh   void sqliteFree(void*);
111075897234Sdrh   void *sqliteRealloc(void*,int);
11116e142f54Sdrh   char *sqliteStrDup(const char*);
11126e142f54Sdrh   char *sqliteStrNDup(const char*, int);
1113ed6c8671Sdrh # define sqliteCheckMemory(a,b)
1114dcc581ccSdrh #endif
1115483750baSdrh char *sqliteMPrintf(const char*, ...);
1116*5f968436Sdrh char *sqliteVMPrintf(const char*, va_list);
111775897234Sdrh void sqliteSetString(char **, const char *, ...);
111875897234Sdrh void sqliteSetNString(char **, ...);
1119da93d238Sdrh void sqliteErrorMsg(Parse*, const char*, ...);
1120982cef7eSdrh void sqliteDequote(char*);
112117f71934Sdrh int sqliteKeywordCode(const char*, int);
112280ff32f5Sdrh int sqliteRunParser(Parse*, const char*, char **);
112375897234Sdrh void sqliteExec(Parse*);
112475897234Sdrh Expr *sqliteExpr(int, Expr*, Expr*, Token*);
1125e1b6a5b8Sdrh void sqliteExprSpan(Expr*,Token*,Token*);
112675897234Sdrh Expr *sqliteExprFunction(ExprList*, Token*);
112775897234Sdrh void sqliteExprDelete(Expr*);
112875897234Sdrh ExprList *sqliteExprListAppend(ExprList*,Expr*,Token*);
112975897234Sdrh void sqliteExprListDelete(ExprList*);
1130e0bc4048Sdrh int sqliteInit(sqlite*, char**);
11311c2d8414Sdrh void sqlitePragma(Parse*,Token*,Token*,int);
11321c2d8414Sdrh void sqliteResetInternalSchema(sqlite*, int);
1133e0bc4048Sdrh void sqliteBeginParse(Parse*,int);
11345e00f6c7Sdrh void sqliteRollbackInternalChanges(sqlite*);
1135e0bc4048Sdrh void sqliteCommitInternalChanges(sqlite*);
1136969fa7c1Sdrh Table *sqliteResultSetOfSelect(Parse*,char*,Select*);
1137e0bc4048Sdrh void sqliteOpenMasterTable(Vdbe *v, int);
1138e5f9c644Sdrh void sqliteStartTable(Parse*,Token*,Token*,int,int);
113975897234Sdrh void sqliteAddColumn(Parse*,Token*);
11409cfcf5d4Sdrh void sqliteAddNotNull(Parse*, int);
11419cfcf5d4Sdrh void sqliteAddPrimaryKey(Parse*, IdList*, int);
1142382c0247Sdrh void sqliteAddColumnType(Parse*,Token*,Token*);
11437020f651Sdrh void sqliteAddDefaultValue(Parse*,Token*,int);
1144fcb78a49Sdrh int sqliteCollateType(const char*, int);
11458e2ca029Sdrh void sqliteAddCollateType(Parse*, int);
1146969fa7c1Sdrh void sqliteEndTable(Parse*,Token*,Select*);
11476276c1cbSdrh void sqliteCreateView(Parse*,Token*,Token*,Select*,int);
1148417be79cSdrh int sqliteViewGetColumnNames(Parse*,Table*);
11494ff6dfa7Sdrh void sqliteDropTable(Parse*, Token*, int);
115075897234Sdrh void sqliteDeleteTable(sqlite*, Table*);
1151113088ecSdrh void sqliteInsert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
115275897234Sdrh IdList *sqliteIdListAppend(IdList*, Token*);
1153ad2d8307Sdrh int sqliteIdListIndex(IdList*,const char*);
1154113088ecSdrh SrcList *sqliteSrcListAppend(SrcList*, Token*, Token*);
1155ad3cab52Sdrh void sqliteSrcListAddAlias(SrcList*, Token*);
11566a3ea0e6Sdrh void sqliteSrcListAssignCursors(Parse*, SrcList*);
115775897234Sdrh void sqliteIdListDelete(IdList*);
1158ad3cab52Sdrh void sqliteSrcListDelete(SrcList*);
11594925ca00Sdrh void sqliteCreateIndex(Parse*,Token*,SrcList*,IdList*,int,Token*,Token*);
1160d24cc427Sdrh void sqliteDropIndex(Parse*, SrcList*);
116138640e15Sdrh void sqliteAddKeyType(Vdbe*, ExprList*);
116238640e15Sdrh void sqliteAddIdxKeyType(Vdbe*, Index*);
11631b2e0329Sdrh int sqliteSelect(Parse*, Select*, int, int, Select*, int, int*);
1164ad3cab52Sdrh Select *sqliteSelectNew(ExprList*,SrcList*,Expr*,ExprList*,Expr*,ExprList*,
11659bbca4c1Sdrh                         int,int,int);
11669bb61fe7Sdrh void sqliteSelectDelete(Select*);
1167ff78bd2fSdrh void sqliteSelectUnbind(Select*);
1168812d7a21Sdrh Table *sqliteSrcListLookup(Parse*, SrcList*);
11695cf590c1Sdrh int sqliteIsReadOnly(Parse*, Table*, int);
1170113088ecSdrh void sqliteDeleteFrom(Parse*, SrcList*, Expr*);
1171113088ecSdrh void sqliteUpdate(Parse*, SrcList*, ExprList*, Expr*, int);
11726a3ea0e6Sdrh WhereInfo *sqliteWhereBegin(Parse*, SrcList*, Expr*, int, ExprList**);
117375897234Sdrh void sqliteWhereEnd(WhereInfo*);
117475897234Sdrh void sqliteExprCode(Parse*, Expr*);
1175f5905aa7Sdrh void sqliteExprIfTrue(Parse*, Expr*, int, int);
1176f5905aa7Sdrh void sqliteExprIfFalse(Parse*, Expr*, int, int);
1177d24cc427Sdrh Table *sqliteFindTable(sqlite*,const char*, const char*);
1178a69d9168Sdrh Table *sqliteLocateTable(Parse*,const char*, const char*);
1179d24cc427Sdrh Index *sqliteFindIndex(sqlite*,const char*, const char*);
11806d4abfbeSdrh void sqliteUnlinkAndDeleteIndex(sqlite*,Index*);
1181d24cc427Sdrh void sqliteCopy(Parse*, SrcList*, Token*, Token*, int);
1182dce2cbe6Sdrh void sqliteVacuum(Parse*, Token*);
11836f8c91caSdrh int sqliteRunVacuum(char**, sqlite*);
1184e17a7e33Sdrh int sqliteGlobCompare(const unsigned char*,const unsigned char*);
1185dce2cbe6Sdrh int sqliteLikeCompare(const unsigned char*,const unsigned char*);
1186cce7d176Sdrh char *sqliteTableNameFromToken(Token*);
1187cce7d176Sdrh int sqliteExprCheck(Parse*, Expr*, int, int*);
1188c9b84a1fSdrh int sqliteExprType(Expr*);
1189d8bc7086Sdrh int sqliteExprCompare(Expr*, Expr*);
1190cce7d176Sdrh int sqliteFuncId(Token*);
11916a3ea0e6Sdrh int sqliteExprResolveIds(Parse*, SrcList*, ExprList*, Expr*);
11922282792aSdrh int sqliteExprAnalyzeAggregates(Parse*, Expr*);
1193d8bc7086Sdrh Vdbe *sqliteGetVdbe(Parse*);
1194bbd82df6Sdrh void sqliteRandomness(int, void*);
1195001bbcbbSdrh void sqliteRollbackAll(sqlite*);
11968bf8dc92Sdrh void sqliteCodeVerifySchema(Parse*, int);
11971c92853dSdrh void sqliteBeginTransaction(Parse*, int);
1198c4a3c779Sdrh void sqliteCommitTransaction(Parse*);
1199c4a3c779Sdrh void sqliteRollbackTransaction(Parse*);
12009208643dSdrh int sqliteExprIsConstant(Expr*);
1201e4de1febSdrh int sqliteExprIsInteger(Expr*, int*);
1202a9f9d1c0Sdrh int sqliteIsRowid(const char*);
120338640e15Sdrh void sqliteGenerateRowDelete(sqlite*, Vdbe*, Table*, int, int);
120438640e15Sdrh void sqliteGenerateRowIndexDelete(sqlite*, Vdbe*, Table*, int, char*);
12050ca3e24bSdrh void sqliteGenerateConstraintChecks(Parse*,Table*,int,char*,int,int,int,int);
120670ce3f0cSdrh void sqliteCompleteInsertion(Parse*, Table*, int, char*, int, int, int);
1207cabb0819Sdrh void sqliteBeginWriteOperation(Parse*, int, int);
12081c92853dSdrh void sqliteEndWriteOperation(Parse*);
1209ff78bd2fSdrh Expr *sqliteExprDup(Expr*);
12104b59ab5eSdrh void sqliteTokenCopy(Token*, Token*);
1211ff78bd2fSdrh ExprList *sqliteExprListDup(ExprList*);
1212ad3cab52Sdrh SrcList *sqliteSrcListDup(SrcList*);
1213ff78bd2fSdrh IdList *sqliteIdListDup(IdList*);
1214ff78bd2fSdrh Select *sqliteSelectDup(Select*);
12150bce8354Sdrh FuncDef *sqliteFindFunction(sqlite*,const char*,int,int,int);
121628f4b688Sdrh void sqliteRegisterBuiltinFunctions(sqlite*);
12177014aff3Sdrh void sqliteRegisterDateTimeFunctions(sqlite*);
1218247be43dSdrh int sqliteSafetyOn(sqlite*);
1219247be43dSdrh int sqliteSafetyOff(sqlite*);
1220c22bd47dSdrh int sqliteSafetyCheck(sqlite*);
1221e0bc4048Sdrh void sqliteChangeCookie(sqlite*, Vdbe*);
1222f0f258b1Sdrh void sqliteBeginTrigger(Parse*, Token*,int,int,IdList*,SrcList*,int,Expr*,int);
1223f0f258b1Sdrh void sqliteFinishTrigger(Parse*, TriggerStep*, Token*);
122479a519c0Sdrh void sqliteDropTrigger(Parse*, SrcList*);
122579a519c0Sdrh void sqliteDropTriggerPtr(Parse*, Trigger*, int);
1226dc379456Sdrh int sqliteTriggersExist(Parse* , Trigger* , int , int , int, ExprList*);
12276f34903eSdanielk1977 int sqliteCodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
12286f34903eSdanielk1977                          int, int);
1229dc379456Sdrh void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
1230f0f258b1Sdrh void sqliteDeleteTriggerStep(TriggerStep*);
1231dc379456Sdrh TriggerStep *sqliteTriggerSelectStep(Select*);
1232dc379456Sdrh TriggerStep *sqliteTriggerInsertStep(Token*, IdList*, ExprList*, Select*, int);
1233dc379456Sdrh TriggerStep *sqliteTriggerUpdateStep(Token*, ExprList*, Expr*, int);
1234dc379456Sdrh TriggerStep *sqliteTriggerDeleteStep(Token*, Expr*);
12351d1f3055Sdrh void sqliteDeleteTrigger(Trigger*);
123601f3f253Sdrh int sqliteJoinType(Parse*, Token*, Token*, Token*);
1237c2eef3b3Sdrh void sqliteCreateForeignKey(Parse*, IdList*, Token*, IdList*, int);
1238c2eef3b3Sdrh void sqliteDeferForeignKey(Parse*, int);
1239ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
12406a3ea0e6Sdrh   void sqliteAuthRead(Parse*,Expr*,SrcList*);
1241e22a334bSdrh   int sqliteAuthCheck(Parse*,int, const char*, const char*, const char*);
124285e2096fSdrh   void sqliteAuthContextPush(Parse*, AuthContext*, const char*);
124385e2096fSdrh   void sqliteAuthContextPop(AuthContext*);
1244ed6c8671Sdrh #else
12456a3ea0e6Sdrh # define sqliteAuthRead(a,b,c)
12467a73eb48Sdrh # define sqliteAuthCheck(a,b,c,d,e)    SQLITE_OK
124785e2096fSdrh # define sqliteAuthContextPush(a,b,c)
12487a73eb48Sdrh # define sqliteAuthContextPop(a)  ((void)(a))
1249ed6c8671Sdrh #endif
12504d189ca4Sdrh void sqliteAttach(Parse*, Token*, Token*, Token*);
12511c2d8414Sdrh void sqliteDetach(Parse*, Token*);
1252bb07e9a3Sdrh int sqliteBtreeFactory(const sqlite *db, const char *zFilename,
1253bb07e9a3Sdrh                        int mode, int nPg, Btree **ppBtree);
1254f26e09c8Sdrh int sqliteFixInit(DbFixer*, Parse*, int, const char*, const Token*);
1255f26e09c8Sdrh int sqliteFixSrcList(DbFixer*, SrcList*);
1256f26e09c8Sdrh int sqliteFixSelect(DbFixer*, Select*);
1257f26e09c8Sdrh int sqliteFixExpr(DbFixer*, Expr*);
1258f26e09c8Sdrh int sqliteFixExprList(DbFixer*, ExprList*);
1259f26e09c8Sdrh int sqliteFixTriggerStep(DbFixer*, TriggerStep*);
126093a5c6bdSdrh double sqliteAtoF(const char *z);
1261*5f968436Sdrh char *sqlite_snprintf(int,char*,const char*,...);
1262202b2df7Sdrh int sqliteFitsIn32Bits(const char *);
1263