xref: /sqlite-3.40.0/src/sqliteInt.h (revision 27436af7)
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*27436af7Sdrh ** @(#) $Id: sqliteInt.h,v 1.492 2006/03/28 23:57:18 drh Exp $
1575897234Sdrh */
16e3026636Sdanielk1977 #ifndef _SQLITEINT_H_
17e3026636Sdanielk1977 #define _SQLITEINT_H_
18e3026636Sdanielk1977 
19eb206256Sdrh /*
20824d7c18Sdrh ** Extra interface definitions for those who need them
21824d7c18Sdrh */
22824d7c18Sdrh #ifdef SQLITE_EXTRA
23824d7c18Sdrh # include "sqliteExtra.h"
24824d7c18Sdrh #endif
25824d7c18Sdrh 
26824d7c18Sdrh /*
274b529d97Sdrh ** Many people are failing to set -DNDEBUG=1 when compiling SQLite.
28b27795c1Sdrh ** Setting NDEBUG makes the code smaller and run faster.  So the following
294b529d97Sdrh ** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1
304b529d97Sdrh ** option is set.  Thus NDEBUG becomes an opt-in rather than an opt-out
314b529d97Sdrh ** feature.
324b529d97Sdrh */
33289ab076Sdrh #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
344b529d97Sdrh # define NDEBUG 1
354b529d97Sdrh #endif
364b529d97Sdrh 
374b529d97Sdrh /*
38eb206256Sdrh ** These #defines should enable >2GB file support on Posix if the
39eb206256Sdrh ** underlying operating system supports it.  If the OS lacks
40eb206256Sdrh ** large file support, or if the OS is windows, these should be no-ops.
41eb206256Sdrh **
42eb206256Sdrh ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
43eb206256Sdrh ** on the compiler command line.  This is necessary if you are compiling
44eb206256Sdrh ** on a recent machine (ex: RedHat 7.2) but you want your code to work
45eb206256Sdrh ** on an older machine (ex: RedHat 6.0).  If you compile on RedHat 7.2
46eb206256Sdrh ** without this option, LFS is enable.  But LFS does not exist in the kernel
47eb206256Sdrh ** in RedHat 6.0, so the code won't work.  Hence, for maximum binary
48eb206256Sdrh ** portability you should omit LFS.
49eb206256Sdrh **
50eb206256Sdrh ** Similar is true for MacOS.  LFS is only supported on MacOS 9 and later.
51eb206256Sdrh */
52eb206256Sdrh #ifndef SQLITE_DISABLE_LFS
53eb206256Sdrh # define _LARGE_FILE       1
54eb206256Sdrh # ifndef _FILE_OFFSET_BITS
55eb206256Sdrh #   define _FILE_OFFSET_BITS 64
56eb206256Sdrh # endif
57eb206256Sdrh # define _LARGEFILE_SOURCE 1
58eb206256Sdrh #endif
59eb206256Sdrh 
601d482dd9Sdrh #include "sqlite3.h"
61beae3194Sdrh #include "hash.h"
6275897234Sdrh #include "parse.h"
6375897234Sdrh #include <stdio.h>
6475897234Sdrh #include <stdlib.h>
6575897234Sdrh #include <string.h>
6675897234Sdrh #include <assert.h>
6752370e2cSdrh #include <stddef.h>
6875897234Sdrh 
69967e8b73Sdrh /*
70b37df7b9Sdrh ** If compiling for a processor that lacks floating point support,
71b37df7b9Sdrh ** substitute integer for floating-point
72b37df7b9Sdrh */
73b37df7b9Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
74b37df7b9Sdrh # define double sqlite_int64
75b37df7b9Sdrh # define LONGDOUBLE_TYPE sqlite_int64
76d1167393Sdrh # ifndef SQLITE_BIG_DBL
77b37df7b9Sdrh #   define SQLITE_BIG_DBL (0x7fffffffffffffff)
78d1167393Sdrh # endif
79b37df7b9Sdrh # define SQLITE_OMIT_DATETIME_FUNCS 1
80b37df7b9Sdrh # define SQLITE_OMIT_TRACE 1
81b37df7b9Sdrh #endif
82d1167393Sdrh #ifndef SQLITE_BIG_DBL
83d1167393Sdrh # define SQLITE_BIG_DBL (1e99)
84d1167393Sdrh #endif
85b37df7b9Sdrh 
86b37df7b9Sdrh /*
87a1b351afSdrh ** The maximum number of in-memory pages to use for the main database
8824c8ab80Sdanielk1977 ** table and for temporary tables. Internally, the MAX_PAGES and
8924c8ab80Sdanielk1977 ** TEMP_PAGES macros are used. To override the default values at
9024c8ab80Sdanielk1977 ** compilation time, the SQLITE_DEFAULT_CACHE_SIZE and
9124c8ab80Sdanielk1977 ** SQLITE_DEFAULT_TEMP_CACHE_SIZE macros should be set.
92a1b351afSdrh */
931ba1e6e0Sdrh #ifdef SQLITE_DEFAULT_CACHE_SIZE
941ba1e6e0Sdrh # define MAX_PAGES SQLITE_DEFAULT_CACHE_SIZE
951ba1e6e0Sdrh #else
96603240cfSdrh # define MAX_PAGES   2000
971ba1e6e0Sdrh #endif
9824c8ab80Sdanielk1977 #ifdef SQLITE_DEFAULT_TEMP_CACHE_SIZE
9924c8ab80Sdanielk1977 # define TEMP_PAGES SQLITE_DEFAULT_TEMP_CACHE_SIZE
10024c8ab80Sdanielk1977 #else
101603240cfSdrh # define TEMP_PAGES   500
10224c8ab80Sdanielk1977 #endif
103a1b351afSdrh 
104a1b351afSdrh /*
10553c0f748Sdanielk1977 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
10653c0f748Sdanielk1977 ** afterward. Having this macro allows us to cause the C compiler
10753c0f748Sdanielk1977 ** to omit code used by TEMP tables without messy #ifndef statements.
10853c0f748Sdanielk1977 */
10953c0f748Sdanielk1977 #ifdef SQLITE_OMIT_TEMPDB
11053c0f748Sdanielk1977 #define OMIT_TEMPDB 1
11153c0f748Sdanielk1977 #else
11253c0f748Sdanielk1977 #define OMIT_TEMPDB 0
11353c0f748Sdanielk1977 #endif
11453c0f748Sdanielk1977 
11553c0f748Sdanielk1977 /*
1160bd1f4eaSdrh ** If the following macro is set to 1, then NULL values are considered
1170bd1f4eaSdrh ** distinct when determining whether or not two entries are the same
1180bd1f4eaSdrh ** in a UNIQUE index.  This is the way PostgreSQL, Oracle, DB2, MySQL,
1190bd1f4eaSdrh ** OCELOT, and Firebird all work.  The SQL92 spec explicitly says this
1200bd1f4eaSdrh ** is the way things are suppose to work.
1210bd1f4eaSdrh **
1220bd1f4eaSdrh ** If the following macro is set to 0, the NULLs are indistinct for
1230bd1f4eaSdrh ** a UNIQUE index.  In this mode, you can only have a single NULL entry
1240bd1f4eaSdrh ** for a column declared UNIQUE.  This is the way Informix and SQL Server
1250bd1f4eaSdrh ** work.
1260bd1f4eaSdrh */
1270bd1f4eaSdrh #define NULL_DISTINCT_FOR_UNIQUE 1
1280bd1f4eaSdrh 
1290bd1f4eaSdrh /*
130665de47aSdrh ** The maximum number of attached databases.  This must be at least 2
131665de47aSdrh ** in order to support the main database file (0) and the file used to
13280242055Sdrh ** hold temporary tables (1).  And it must be less than 32 because
13380242055Sdrh ** we use a bitmask of databases with a u32 in places (for example
13480242055Sdrh ** the Parse.cookieMask field).
135665de47aSdrh */
136665de47aSdrh #define MAX_ATTACHED 10
137665de47aSdrh 
138665de47aSdrh /*
139fa6bc000Sdrh ** The maximum value of a ?nnn wildcard that the parser will accept.
140fa6bc000Sdrh */
141fa6bc000Sdrh #define SQLITE_MAX_VARIABLE_NUMBER 999
142fa6bc000Sdrh 
143fa6bc000Sdrh /*
144d946db00Sdrh ** The "file format" number is an integer that is incremented whenever
145d946db00Sdrh ** the VDBE-level file format changes.  The following macros define the
146d946db00Sdrh ** the default file format for new databases and the maximum file format
147d946db00Sdrh ** that the library can read.
148d946db00Sdrh */
149d946db00Sdrh #define SQLITE_MAX_FILE_FORMAT 4
150d946db00Sdrh #ifndef SQLITE_DEFAULT_FILE_FORMAT
151d946db00Sdrh # define SQLITE_DEFAULT_FILE_FORMAT 4
152d946db00Sdrh #endif
153d946db00Sdrh 
154d946db00Sdrh /*
15549766d6cSdrh ** Provide a default value for TEMP_STORE in case it is not specified
15649766d6cSdrh ** on the command-line
15749766d6cSdrh */
15849766d6cSdrh #ifndef TEMP_STORE
15949766d6cSdrh # define TEMP_STORE 1
16049766d6cSdrh #endif
16149766d6cSdrh 
16249766d6cSdrh /*
163f1974846Sdrh ** GCC does not define the offsetof() macro so we'll have to do it
164f1974846Sdrh ** ourselves.
165f1974846Sdrh */
166f1974846Sdrh #ifndef offsetof
167f1974846Sdrh #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
168f1974846Sdrh #endif
169f1974846Sdrh 
170f1974846Sdrh /*
1715a2c2c20Sdrh ** Integers of known sizes.  These typedefs might change for architectures
1725a2c2c20Sdrh ** where the sizes very.  Preprocessor macros are available so that the
1735a2c2c20Sdrh ** types can be conveniently redefined at compile-type.  Like this:
1745a2c2c20Sdrh **
1755a2c2c20Sdrh **         cc '-DUINTPTR_TYPE=long long int' ...
17641a2b48bSdrh */
1775a2c2c20Sdrh #ifndef UINT32_TYPE
1785a2c2c20Sdrh # define UINT32_TYPE unsigned int
1795a2c2c20Sdrh #endif
1805a2c2c20Sdrh #ifndef UINT16_TYPE
1815a2c2c20Sdrh # define UINT16_TYPE unsigned short int
1825a2c2c20Sdrh #endif
183939a16d6Sdrh #ifndef INT16_TYPE
184939a16d6Sdrh # define INT16_TYPE short int
185939a16d6Sdrh #endif
1865a2c2c20Sdrh #ifndef UINT8_TYPE
1875a2c2c20Sdrh # define UINT8_TYPE unsigned char
1885a2c2c20Sdrh #endif
189905793e2Sdrh #ifndef INT8_TYPE
190905793e2Sdrh # define INT8_TYPE signed char
191905793e2Sdrh #endif
192efad9995Sdrh #ifndef LONGDOUBLE_TYPE
193efad9995Sdrh # define LONGDOUBLE_TYPE long double
194efad9995Sdrh #endif
195efad9995Sdrh typedef sqlite_int64 i64;          /* 8-byte signed integer */
196*27436af7Sdrh typedef sqlite_uint64 u64;         /* 8-byte unsigned integer */
1975a2c2c20Sdrh typedef UINT32_TYPE u32;           /* 4-byte unsigned integer */
1985a2c2c20Sdrh typedef UINT16_TYPE u16;           /* 2-byte unsigned integer */
199939a16d6Sdrh typedef INT16_TYPE i16;            /* 2-byte signed integer */
2005a2c2c20Sdrh typedef UINT8_TYPE u8;             /* 1-byte unsigned integer */
201905793e2Sdrh typedef UINT8_TYPE i8;             /* 1-byte signed integer */
2025a2c2c20Sdrh 
2035a2c2c20Sdrh /*
204bbd42a6dSdrh ** Macros to determine whether the machine is big or little endian,
205bbd42a6dSdrh ** evaluated at runtime.
206bbd42a6dSdrh */
207bbd42a6dSdrh extern const int sqlite3one;
2089c054830Sdrh #define SQLITE_BIGENDIAN    (*(char *)(&sqlite3one)==0)
2099c054830Sdrh #define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
210bbd42a6dSdrh 
211bbd42a6dSdrh /*
21290f5ecb3Sdrh ** An instance of the following structure is used to store the busy-handler
21390f5ecb3Sdrh ** callback for a given sqlite handle.
21490f5ecb3Sdrh **
21590f5ecb3Sdrh ** The sqlite.busyHandler member of the sqlite struct contains the busy
21690f5ecb3Sdrh ** callback for the database handle. Each pager opened via the sqlite
21790f5ecb3Sdrh ** handle is passed a pointer to sqlite.busyHandler. The busy-handler
21890f5ecb3Sdrh ** callback is currently invoked only from within pager.c.
21990f5ecb3Sdrh */
22090f5ecb3Sdrh typedef struct BusyHandler BusyHandler;
22190f5ecb3Sdrh struct BusyHandler {
22290f5ecb3Sdrh   int (*xFunc)(void *,int);  /* The busy callback */
22390f5ecb3Sdrh   void *pArg;                /* First arg to busy callback */
224a4afb65cSdrh   int nBusy;                 /* Incremented with each busy call */
22590f5ecb3Sdrh };
22690f5ecb3Sdrh 
22790f5ecb3Sdrh /*
22890f5ecb3Sdrh ** Defer sourcing vdbe.h and btree.h until after the "u8" and
22990f5ecb3Sdrh ** "BusyHandler typedefs.
230905793e2Sdrh */
231905793e2Sdrh #include "vdbe.h"
2323aac2dd7Sdrh #include "btree.h"
23313f7299bSdanielk1977 #include "pager.h"
234905793e2Sdrh 
2352c336549Sdanielk1977 #ifdef SQLITE_MEMDEBUG
23675897234Sdrh /*
2376e142f54Sdrh ** The following global variables are used for testing and debugging
238c00da105Sdanielk1977 ** only.  They only work if SQLITE_MEMDEBUG is defined.
2396e142f54Sdrh */
2406f8a503dSdanielk1977 extern int sqlite3_nMalloc;      /* Number of sqliteMalloc() calls */
2416f8a503dSdanielk1977 extern int sqlite3_nFree;        /* Number of sqliteFree() calls */
2426f8a503dSdanielk1977 extern int sqlite3_iMallocFail;  /* Fail sqliteMalloc() after this many calls */
2434693423bSdrh extern int sqlite3_iMallocReset; /* Set iMallocFail to this when it reaches 0 */
2449e12800dSdanielk1977 
2459e12800dSdanielk1977 extern void *sqlite3_pFirst;         /* Pointer to linked list of allocations */
2469e12800dSdanielk1977 extern int sqlite3_nMaxAlloc;        /* High water mark of ThreadData.nAlloc */
2479e12800dSdanielk1977 extern int sqlite3_mallocDisallowed; /* assert() in sqlite3Malloc() if set */
2489e12800dSdanielk1977 extern int sqlite3_isFail;           /* True if all malloc calls should fail */
2499e12800dSdanielk1977 extern const char *sqlite3_zFile;    /* Filename to associate debug info with */
2509e12800dSdanielk1977 extern int sqlite3_iLine;            /* Line number for debug info */
2519e12800dSdanielk1977 
2529e12800dSdanielk1977 #define ENTER_MALLOC (sqlite3_zFile = __FILE__, sqlite3_iLine = __LINE__)
253750b03e5Sdanielk1977 #define sqliteMalloc(x)          (ENTER_MALLOC, sqlite3Malloc(x,1))
254750b03e5Sdanielk1977 #define sqliteMallocRaw(x)       (ENTER_MALLOC, sqlite3MallocRaw(x,1))
2552e588c75Sdanielk1977 #define sqliteRealloc(x,y)       (ENTER_MALLOC, sqlite3Realloc(x,y))
2562e588c75Sdanielk1977 #define sqliteStrDup(x)          (ENTER_MALLOC, sqlite3StrDup(x))
2572e588c75Sdanielk1977 #define sqliteStrNDup(x,y)       (ENTER_MALLOC, sqlite3StrNDup(x,y))
258c00da105Sdanielk1977 #define sqliteReallocOrFree(x,y) (ENTER_MALLOC, sqlite3ReallocOrFree(x,y))
2592e588c75Sdanielk1977 
26097cb2e96Sdanielk1977 #else
26197cb2e96Sdanielk1977 
2628ae59d52Sdanielk1977 #define ENTER_MALLOC 0
263e8c15132Sdrh #define sqliteMalloc(x)          sqlite3Malloc(x,1)
264e8c15132Sdrh #define sqliteMallocRaw(x)       sqlite3MallocRaw(x,1)
26597cb2e96Sdanielk1977 #define sqliteRealloc(x,y)       sqlite3Realloc(x,y)
26697cb2e96Sdanielk1977 #define sqliteStrDup(x)          sqlite3StrDup(x)
26797cb2e96Sdanielk1977 #define sqliteStrNDup(x,y)       sqlite3StrNDup(x,y)
268c00da105Sdanielk1977 #define sqliteReallocOrFree(x,y) sqlite3ReallocOrFree(x,y)
26997cb2e96Sdanielk1977 
27097cb2e96Sdanielk1977 #endif
27197cb2e96Sdanielk1977 
27297cb2e96Sdanielk1977 #define sqliteFree(x)          sqlite3FreeX(x)
27313f7299bSdanielk1977 #define sqliteAllocSize(x)     sqlite3AllocSize(x)
27497cb2e96Sdanielk1977 
275e7259296Sdanielk1977 
2762e588c75Sdanielk1977 /*
2776f7adc8aSdrh ** An instance of this structure might be allocated to store information
2786f7adc8aSdrh ** specific to a single thread.
2792e588c75Sdanielk1977 */
280e501b89aSdanielk1977 struct ThreadData {
2816dc1d95dSdrh   int dummy;               /* So that this structure is never empty */
2825591df55Sdanielk1977 
2836f7adc8aSdrh #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
284d2d4a6b0Sdrh   int nSoftHeapLimit;      /* Suggested max mem allocation.  No limit if <0 */
285d2d4a6b0Sdrh   int nAlloc;              /* Number of bytes currently allocated */
28613f7299bSdanielk1977   Pager *pPager;           /* Linked list of all pagers in this thread */
2877ddad969Sdanielk1977 #endif
2887ddad969Sdanielk1977 
289aef0bf64Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
290aef0bf64Sdanielk1977   u8 useSharedData;        /* True if shared pagers and schemas are enabled */
291d78901daSdrh   BtShared *pBtree;        /* Linked list of all currently open BTrees */
292aef0bf64Sdanielk1977 #endif
2932e588c75Sdanielk1977 };
2942e588c75Sdanielk1977 
2956e142f54Sdrh /*
29675897234Sdrh ** Name of the master database table.  The master database table
29775897234Sdrh ** is a special table that holds the names and attributes of all
29875897234Sdrh ** user tables and indices.
29975897234Sdrh */
30075897234Sdrh #define MASTER_NAME       "sqlite_master"
301e0bc4048Sdrh #define TEMP_MASTER_NAME  "sqlite_temp_master"
30275897234Sdrh 
30375897234Sdrh /*
3048e150818Sdanielk1977 ** The root-page of the master database table.
3058e150818Sdanielk1977 */
3068e150818Sdanielk1977 #define MASTER_ROOT       1
3078e150818Sdanielk1977 
3088e150818Sdanielk1977 /*
309ed6c8671Sdrh ** The name of the schema table.
310ed6c8671Sdrh */
31153c0f748Sdanielk1977 #define SCHEMA_TABLE(x)  ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
312ed6c8671Sdrh 
313ed6c8671Sdrh /*
31475897234Sdrh ** A convenience macro that returns the number of elements in
31575897234Sdrh ** an array.
31675897234Sdrh */
31775897234Sdrh #define ArraySize(X)    (sizeof(X)/sizeof(X[0]))
31875897234Sdrh 
31975897234Sdrh /*
32075897234Sdrh ** Forward references to structures
32175897234Sdrh */
32213449892Sdrh typedef struct AggInfo AggInfo;
323fe05af87Sdrh typedef struct AuthContext AuthContext;
324fe05af87Sdrh typedef struct CollSeq CollSeq;
3257020f651Sdrh typedef struct Column Column;
326fe05af87Sdrh typedef struct Db Db;
327e501b89aSdanielk1977 typedef struct Schema Schema;
32875897234Sdrh typedef struct Expr Expr;
32975897234Sdrh typedef struct ExprList ExprList;
330c2eef3b3Sdrh typedef struct FKey FKey;
331fe05af87Sdrh typedef struct FuncDef FuncDef;
332fe05af87Sdrh typedef struct IdList IdList;
333fe05af87Sdrh typedef struct Index Index;
3348d059845Sdanielk1977 typedef struct KeyClass KeyClass;
335d3d39e93Sdrh typedef struct KeyInfo KeyInfo;
336626a879aSdrh typedef struct NameContext NameContext;
337fe05af87Sdrh typedef struct Parse Parse;
338fe05af87Sdrh typedef struct Select Select;
339fe05af87Sdrh typedef struct SrcList SrcList;
340e501b89aSdanielk1977 typedef struct ThreadData ThreadData;
341fe05af87Sdrh typedef struct Table Table;
342c00da105Sdanielk1977 typedef struct TableLock TableLock;
343fe05af87Sdrh typedef struct Token Token;
344fe05af87Sdrh typedef struct TriggerStack TriggerStack;
345fe05af87Sdrh typedef struct TriggerStep TriggerStep;
346fe05af87Sdrh typedef struct Trigger Trigger;
347fe05af87Sdrh typedef struct WhereInfo WhereInfo;
348fe05af87Sdrh typedef struct WhereLevel WhereLevel;
349d3d39e93Sdrh 
350001bbcbbSdrh /*
351001bbcbbSdrh ** Each database file to be accessed by the system is an instance
352001bbcbbSdrh ** of the following structure.  There are normally two of these structures
353001bbcbbSdrh ** in the sqlite.aDb[] array.  aDb[0] is the main database file and
354a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables.  Additional
355a69d9168Sdrh ** databases may be attached.
356001bbcbbSdrh */
357001bbcbbSdrh struct Db {
358001bbcbbSdrh   char *zName;         /* Name of this database */
359001bbcbbSdrh   Btree *pBt;          /* The B*Tree structure for this database file */
360da184236Sdanielk1977   u8 inTrans;          /* 0: not writable.  1: Transaction.  2: Checkpoint */
361da184236Sdanielk1977   u8 safety_level;     /* How aggressive at synching data to disk */
362da184236Sdanielk1977   void *pAux;               /* Auxiliary data.  Usually NULL */
363da184236Sdanielk1977   void (*xFreeAux)(void*);  /* Routine to free pAux */
364e501b89aSdanielk1977   Schema *pSchema;     /* Pointer to database schema (possibly shared) */
365da184236Sdanielk1977 };
366da184236Sdanielk1977 
367da184236Sdanielk1977 /*
368da184236Sdanielk1977 ** An instance of the following structure stores a database schema.
369da184236Sdanielk1977 */
370e501b89aSdanielk1977 struct Schema {
371001bbcbbSdrh   int schema_cookie;   /* Database schema version number for this file */
372d24cc427Sdrh   Hash tblHash;        /* All tables indexed by name */
373d24cc427Sdrh   Hash idxHash;        /* All (named) indices indexed by name */
374d24cc427Sdrh   Hash trigHash;       /* All triggers indexed by name */
375d24cc427Sdrh   Hash aFKey;          /* Foreign keys indexed by to-table */
3764794f735Sdrh   Table *pSeqTab;      /* The sqlite_sequence table used by AUTOINCREMENT */
377da184236Sdanielk1977   u8 file_format;      /* Schema format version for this file */
3788079a0d3Sdrh   u8 enc;              /* Text encoding used by this database */
379da184236Sdanielk1977   u16 flags;           /* Flags associated with this schema */
38014db2665Sdanielk1977   int cache_size;      /* Number of pages to use in the cache */
381001bbcbbSdrh };
38275897234Sdrh 
38375897234Sdrh /*
3848bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the
3858bf8dc92Sdrh ** Db.flags field.
3868bf8dc92Sdrh */
387da184236Sdanielk1977 #define DbHasProperty(D,I,P)     (((D)->aDb[I].pSchema->flags&(P))==(P))
388da184236Sdanielk1977 #define DbHasAnyProperty(D,I,P)  (((D)->aDb[I].pSchema->flags&(P))!=0)
389da184236Sdanielk1977 #define DbSetProperty(D,I,P)     (D)->aDb[I].pSchema->flags|=(P)
390da184236Sdanielk1977 #define DbClearProperty(D,I,P)   (D)->aDb[I].pSchema->flags&=~(P)
3918bf8dc92Sdrh 
3928bf8dc92Sdrh /*
3938bf8dc92Sdrh ** Allowed values for the DB.flags field.
3948bf8dc92Sdrh **
3958bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been
3968bf8dc92Sdrh ** read into internal hash tables.
3978bf8dc92Sdrh **
3988bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that
3998bf8dc92Sdrh ** have been filled out.  If the schema changes, these column names might
4008bf8dc92Sdrh ** changes and so the view will need to be reset.
4018bf8dc92Sdrh */
402124b27e6Sdrh #define DB_SchemaLoaded    0x0001  /* The schema has been loaded */
403124b27e6Sdrh #define DB_UnresetViews    0x0002  /* Some views have defined column names */
404b82e7edaSdanielk1977 #define DB_Empty           0x0004  /* The file is empty (length 0 bytes) */
4058bf8dc92Sdrh 
406dc8453fdSdanielk1977 #define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
4078bf8dc92Sdrh 
4088bf8dc92Sdrh /*
409c9b84a1fSdrh ** Each database is an instance of the following structure.
410c9b84a1fSdrh **
411b0c374ffSrdc ** The sqlite.lastRowid records the last insert rowid generated by an
412b0c374ffSrdc ** insert statement.  Inserts on views do not affect its value.  Each
413b0c374ffSrdc ** trigger has its own context, so that lastRowid can be updated inside
414b0c374ffSrdc ** triggers as usual.  The previous value will be restored once the trigger
415b0c374ffSrdc ** exits.  Upon entering a before or instead of trigger, lastRowid is no
416b0c374ffSrdc ** longer (since after version 2.8.12) reset to -1.
417b0c374ffSrdc **
418b0c374ffSrdc ** The sqlite.nChange does not count changes within triggers and keeps no
4196f8a503dSdanielk1977 ** context.  It is reset at start of sqlite3_exec.
420b0c374ffSrdc ** The sqlite.lsChange represents the number of changes made by the last
421b0c374ffSrdc ** insert, update, or delete statement.  It remains constant throughout the
422b0c374ffSrdc ** length of a statement and is then updated by OP_SetCounts.  It keeps a
423b0c374ffSrdc ** context stack just like lastRowid so that the count of changes
424b0c374ffSrdc ** within a trigger is not seen outside the trigger.  Changes to views do not
425b0c374ffSrdc ** affect the value of lsChange.
426b0c374ffSrdc ** The sqlite.csChange keeps track of the number of current changes (since
427b0c374ffSrdc ** the last statement) and is used to update sqlite_lsChange.
4286622cce3Sdanielk1977 **
4296622cce3Sdanielk1977 ** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
4306622cce3Sdanielk1977 ** store the most recent error code and, if applicable, string. The
4316622cce3Sdanielk1977 ** internal function sqlite3Error() is used to set these variables
4326622cce3Sdanielk1977 ** consistently.
43375897234Sdrh */
4349bb575fdSdrh struct sqlite3 {
435001bbcbbSdrh   int nDb;                      /* Number of backends currently in use */
436001bbcbbSdrh   Db *aDb;                      /* All backends */
4378c82b350Sdrh   int flags;                    /* Miscellanous flags. See below */
438fcd35c7bSdrh   int errCode;                  /* Most recent error code (SQLITE_*) */
439fcd35c7bSdrh   u8 autoCommit;                /* The auto-commit flag. */
44090f5ecb3Sdrh   u8 temp_store;                /* 1: file 2: memory 0: default */
4412803757aSdrh   int nTable;                   /* Number of tables in the database */
442d3d39e93Sdrh   CollSeq *pDfltColl;           /* The default collating sequence (BINARY) */
443f328bc80Sdrh   i64 lastRowid;                /* ROWID of most recent insert (see above) */
444f328bc80Sdrh   i64 priorNewRowid;            /* Last randomly generated ROWID */
445247be43dSdrh   int magic;                    /* Magic number for detect library misuse */
446b28af71aSdanielk1977   int nChange;                  /* Value returned by sqlite3_changes() */
447b28af71aSdanielk1977   int nTotalChange;             /* Value returned by sqlite3_total_changes() */
4484adee20fSdanielk1977   struct sqlite3InitInfo {      /* Information used during initialization */
4491d85d931Sdrh     int iDb;                    /* When back is being initialized */
4501d85d931Sdrh     int newTnum;                /* Rootpage of table being initialized */
4511d85d931Sdrh     u8 busy;                    /* TRUE if currently initializing */
4521d85d931Sdrh   } init;
453326dce74Sdrh   struct Vdbe *pVdbe;           /* List of active virtual machines */
4541d850a72Sdanielk1977   int activeVdbeCnt;            /* Number of vdbes currently executing */
45518de4824Sdrh   void (*xTrace)(void*,const char*);        /* Trace function */
45618de4824Sdrh   void *pTraceArg;                          /* Argument to the trace function */
45719e2d37fSdrh   void (*xProfile)(void*,const char*,u64);  /* Profiling function */
45819e2d37fSdrh   void *pProfileArg;                        /* Argument to profile function */
459fcd35c7bSdrh   void *pCommitArg;                 /* Argument to xCommitCallback() */
460fcd35c7bSdrh   int (*xCommitCallback)(void*);    /* Invoked at every commit. */
46171fd80bfSdanielk1977   void *pRollbackArg;               /* Argument to xRollbackCallback() */
46271fd80bfSdanielk1977   void (*xRollbackCallback)(void*); /* Invoked at every commit. */
46394eb6a14Sdanielk1977   void *pUpdateArg;
46494eb6a14Sdanielk1977   void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
465fcd35c7bSdrh   void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
466fcd35c7bSdrh   void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
467fcd35c7bSdrh   void *pCollNeededArg;
468fcd35c7bSdrh   sqlite3_value *pErr;          /* Most recent error message */
469fcd35c7bSdrh   char *zErrMsg;                /* Most recent error message (UTF-8 encoded) */
470fcd35c7bSdrh   char *zErrMsg16;              /* Most recent error message (UTF-16 encoded) */
471ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
472e22a334bSdrh   int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
473e22a334bSdrh                                 /* Access authorization function */
474ed6c8671Sdrh   void *pAuthArg;               /* 1st argument to the access auth function */
475ed6c8671Sdrh #endif
476348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
477348bb5d6Sdanielk1977   int (*xProgress)(void *);     /* The progress callback */
478348bb5d6Sdanielk1977   void *pProgressArg;           /* Argument to the progress callback */
479348bb5d6Sdanielk1977   int nProgressOps;             /* Number of opcodes for progress callback */
480348bb5d6Sdanielk1977 #endif
4816b456a2bSdanielk1977 #ifndef SQLITE_OMIT_GLOBALRECOVER
4826b456a2bSdanielk1977   sqlite3 *pNext;               /* Linked list of open db handles. */
4836b456a2bSdanielk1977 #endif
484fcd35c7bSdrh   Hash aFunc;                   /* All functions that can be in SQL exprs */
485fcd35c7bSdrh   Hash aCollSeq;                /* All collating sequences */
486fcd35c7bSdrh   BusyHandler busyHandler;      /* Busy callback */
48797903fefSdrh   int busyTimeout;             /* Busy handler timeout, in msec */
488fcd35c7bSdrh   Db aDbStatic[2];              /* Static space for the 2 default backends */
4897e900abfSdanielk1977 #ifdef SQLITE_SSE
4907e900abfSdanielk1977   sqlite3_stmt *pFetch;         /* Used by SSE to fetch stored statements */
4917e900abfSdanielk1977 #endif
49275897234Sdrh };
49375897234Sdrh 
49403b808a6Sdrh /*
49503b808a6Sdrh ** A macro to discover the encoding of a database.
49603b808a6Sdrh */
49714db2665Sdanielk1977 #define ENC(db) ((db)->aDb[0].pSchema->enc)
49814db2665Sdanielk1977 
49975897234Sdrh /*
5008bf8dc92Sdrh ** Possible values for the sqlite.flags and or Db.flags fields.
5018bf8dc92Sdrh **
5028bf8dc92Sdrh ** On sqlite.flags, the SQLITE_InTrans value means that we have
5038bf8dc92Sdrh ** executed a BEGIN.  On Db.flags, SQLITE_InTrans means a statement
5048bf8dc92Sdrh ** transaction is active on that particular database file.
50575897234Sdrh */
5064c504391Sdrh #define SQLITE_VdbeTrace      0x00000001  /* True to trace VDBE execution */
5074c504391Sdrh #define SQLITE_Interrupt      0x00000004  /* Cancel current operation */
508c4a3c779Sdrh #define SQLITE_InTrans        0x00000008  /* True if in a transaction */
5095e00f6c7Sdrh #define SQLITE_InternChanges  0x00000010  /* Uncommitted Hash table changes */
510382c0247Sdrh #define SQLITE_FullColNames   0x00000020  /* Show full column names on SELECT */
511fcabd464Sdrh #define SQLITE_ShortColNames  0x00000040  /* Show short columns names */
512fcabd464Sdrh #define SQLITE_CountRows      0x00000080  /* Count rows changed by INSERT, */
5131bee3d7bSdrh                                           /*   DELETE, or UPDATE and return */
5141bee3d7bSdrh                                           /*   the count using a callback. */
515fcabd464Sdrh #define SQLITE_NullCallback   0x00000100  /* Invoke the callback once if the */
5166a535340Sdrh                                           /*   result set is empty */
51735d4c2f4Sdrh #define SQLITE_SqlTrace       0x00000200  /* Debug print SQL as it executes */
51835d4c2f4Sdrh #define SQLITE_VdbeListing    0x00000400  /* Debug listings of VDBE programs */
519f404083eSdrh #define SQLITE_WriteSchema    0x00000800  /* OK to update SQLITE_MASTER */
5207bec505eSdrh #define SQLITE_NoReadlock     0x00001000  /* Readlocks are omitted when
5217bec505eSdrh                                           ** accessing read-only databases */
5220cd2d4c9Sdrh #define SQLITE_IgnoreChecks   0x00002000  /* Do not enforce check constraints */
523da184236Sdanielk1977 #define SQLITE_ReadUncommitted 0x00004000  /* For shared-cache mode */
524e321c29aSdrh #define SQLITE_LegacyFileFmt  0x00008000  /* Create new databases in format 1 */
525ac530b1aSdrh #define SQLITE_FullFSync      0x00010000  /* Use full fsync on the backend */
52658b9576bSdrh 
52758b9576bSdrh /*
528247be43dSdrh ** Possible values for the sqlite.magic field.
529247be43dSdrh ** The numbers are obtained at random and have no special meaning, other
530247be43dSdrh ** than being distinct from one another.
531247be43dSdrh */
532247be43dSdrh #define SQLITE_MAGIC_OPEN     0xa029a697  /* Database is open */
533247be43dSdrh #define SQLITE_MAGIC_CLOSED   0x9f3c2d33  /* Database is closed */
534247be43dSdrh #define SQLITE_MAGIC_BUSY     0xf03b7906  /* Database currently in use */
535247be43dSdrh #define SQLITE_MAGIC_ERROR    0xb5357930  /* An SQLITE_MISUSE error occurred */
536247be43dSdrh 
537247be43dSdrh /*
5380bce8354Sdrh ** Each SQL function is defined by an instance of the following
5390bce8354Sdrh ** structure.  A pointer to this structure is stored in the sqlite.aFunc
5408e0a2f90Sdrh ** hash table.  When multiple functions have the same name, the hash table
5418e0a2f90Sdrh ** points to a linked list of these structures.
5422803757aSdrh */
5430bce8354Sdrh struct FuncDef {
54455ef4d97Sdrh   i16 nArg;            /* Number of arguments.  -1 means unlimited */
545d8123366Sdanielk1977   u8 iPrefEnc;         /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
54655ef4d97Sdrh   u8 needCollSeq;      /* True if sqlite3GetFuncCollSeq() might be called */
54755ef4d97Sdrh   u8 flags;            /* Some combination of SQLITE_FUNC_* */
5481350b030Sdrh   void *pUserData;     /* User data parameter */
5490bce8354Sdrh   FuncDef *pNext;      /* Next function with same name */
550f9b596ebSdrh   void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
551f9b596ebSdrh   void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
552f9b596ebSdrh   void (*xFinalize)(sqlite3_context*);                /* Aggregate finializer */
55355ef4d97Sdrh   char zName[1];       /* SQL name of the function.  MUST BE LAST */
5548e0a2f90Sdrh };
5552803757aSdrh 
5562803757aSdrh /*
55755ef4d97Sdrh ** Possible values for FuncDef.flags
55855ef4d97Sdrh */
559d64fe2f3Sdrh #define SQLITE_FUNC_LIKE   0x01  /* Candidate for the LIKE optimization */
560d64fe2f3Sdrh #define SQLITE_FUNC_CASE   0x02  /* Case-sensitive LIKE-type function */
56155ef4d97Sdrh 
56255ef4d97Sdrh /*
563967e8b73Sdrh ** information about each column of an SQL table is held in an instance
5647020f651Sdrh ** of this structure.
5657020f651Sdrh */
5667020f651Sdrh struct Column {
5677020f651Sdrh   char *zName;     /* Name of this column */
5687977a17fSdanielk1977   Expr *pDflt;     /* Default value of this column */
569382c0247Sdrh   char *zType;     /* Data type for this column */
570b3bf556eSdanielk1977   char *zColl;     /* Collating sequence.  If NULL, use the default */
5714a32431cSdrh   u8 notNull;      /* True if there is a NOT NULL constraint */
57278100cc9Sdrh   u8 isPrimKey;    /* True if this column is part of the PRIMARY KEY */
573a37cdde0Sdanielk1977   char affinity;   /* One of the SQLITE_AFF_... values */
5747020f651Sdrh };
5757020f651Sdrh 
5767020f651Sdrh /*
577a9fd84b0Sdrh ** A "Collating Sequence" is defined by an instance of the following
5780202b29eSdanielk1977 ** structure. Conceptually, a collating sequence consists of a name and
5790202b29eSdanielk1977 ** a comparison routine that defines the order of that sequence.
580a9fd84b0Sdrh **
5810202b29eSdanielk1977 ** There may two seperate implementations of the collation function, one
5820202b29eSdanielk1977 ** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
5830202b29eSdanielk1977 ** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
5840202b29eSdanielk1977 ** native byte order. When a collation sequence is invoked, SQLite selects
5850202b29eSdanielk1977 ** the version that will require the least expensive encoding
586b3bf556eSdanielk1977 ** translations, if any.
5870202b29eSdanielk1977 **
5880202b29eSdanielk1977 ** The CollSeq.pUser member variable is an extra parameter that passed in
5890202b29eSdanielk1977 ** as the first argument to the UTF-8 comparison function, xCmp.
5900202b29eSdanielk1977 ** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
5910202b29eSdanielk1977 ** xCmp16.
5920202b29eSdanielk1977 **
5930202b29eSdanielk1977 ** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
5940202b29eSdanielk1977 ** collating sequence is undefined.  Indices built on an undefined
5950202b29eSdanielk1977 ** collating sequence may not be read or written.
596a9fd84b0Sdrh */
597a9fd84b0Sdrh struct CollSeq {
5980202b29eSdanielk1977   char *zName;         /* Name of the collating sequence, UTF-8 encoded */
599466be56bSdanielk1977   u8 enc;              /* Text encoding handled by xCmp() */
600d64fe2f3Sdrh   u8 type;             /* One of the SQLITE_COLL_... values below */
601a9fd84b0Sdrh   void *pUser;         /* First argument to xCmp() */
6020202b29eSdanielk1977   int (*xCmp)(void*,int, const void*, int, const void*);
603a9fd84b0Sdrh };
604a9fd84b0Sdrh 
605a9fd84b0Sdrh /*
606d64fe2f3Sdrh ** Allowed values of CollSeq flags:
607d64fe2f3Sdrh */
608d64fe2f3Sdrh #define SQLITE_COLL_BINARY  1  /* The default memcmp() collating sequence */
609d64fe2f3Sdrh #define SQLITE_COLL_NOCASE  2  /* The built-in NOCASE collating sequence */
610d64fe2f3Sdrh #define SQLITE_COLL_REVERSE 3  /* The built-in REVERSE collating sequence */
611d64fe2f3Sdrh #define SQLITE_COLL_USER    0  /* Any other user-defined collating sequence */
612d64fe2f3Sdrh 
613d64fe2f3Sdrh /*
614d3d39e93Sdrh ** A sort order can be either ASC or DESC.
6158e2ca029Sdrh */
6168e2ca029Sdrh #define SQLITE_SO_ASC       0  /* Sort in ascending order */
617d3d39e93Sdrh #define SQLITE_SO_DESC      1  /* Sort in ascending order */
6188e2ca029Sdrh 
6198e2ca029Sdrh /*
620a37cdde0Sdanielk1977 ** Column affinity types.
6218a51256cSdrh **
6228a51256cSdrh ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
6238a51256cSdrh ** 't' for SQLITE_AFF_TEXT.  But we can save a little space and improve
6248a51256cSdrh ** the speed a little by number the values consecutively.
6258a51256cSdrh **
6268a51256cSdrh ** But rather than start with 0 or 1, we begin with 'a'.  That way,
6278a51256cSdrh ** when multiple affinity types are concatenated into a string and
6288a51256cSdrh ** used as the P3 operand, they will be more readable.
6298a51256cSdrh **
6308a51256cSdrh ** Note also that the numeric types are grouped together so that testing
6318a51256cSdrh ** for a numeric type is a single comparison.
632a37cdde0Sdanielk1977 */
6338a51256cSdrh #define SQLITE_AFF_TEXT     'a'
6348a51256cSdrh #define SQLITE_AFF_NONE     'b'
6358a51256cSdrh #define SQLITE_AFF_NUMERIC  'c'
6368a51256cSdrh #define SQLITE_AFF_INTEGER  'd'
6378a51256cSdrh #define SQLITE_AFF_REAL     'e'
638a37cdde0Sdanielk1977 
6398a51256cSdrh #define sqlite3IsNumericAffinity(X)  ((X)>=SQLITE_AFF_NUMERIC)
640a37cdde0Sdanielk1977 
641a37cdde0Sdanielk1977 /*
64222f70c32Sdrh ** Each SQL table is represented in memory by an instance of the
64322f70c32Sdrh ** following structure.
64422f70c32Sdrh **
645d24cc427Sdrh ** Table.zName is the name of the table.  The case of the original
64622f70c32Sdrh ** CREATE TABLE statement is stored, but case is not significant for
64722f70c32Sdrh ** comparisons.
64822f70c32Sdrh **
649d24cc427Sdrh ** Table.nCol is the number of columns in this table.  Table.aCol is a
65022f70c32Sdrh ** pointer to an array of Column structures, one for each column.
65122f70c32Sdrh **
652d24cc427Sdrh ** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
653d24cc427Sdrh ** the column that is that key.   Otherwise Table.iPKey is negative.  Note
65422f70c32Sdrh ** that the datatype of the PRIMARY KEY must be INTEGER for this field to
65522f70c32Sdrh ** be set.  An INTEGER PRIMARY KEY is used as the rowid for each row of
65622f70c32Sdrh ** the table.  If a table has no INTEGER PRIMARY KEY, then a random rowid
657d24cc427Sdrh ** is generated for each row of the table.  Table.hasPrimKey is true if
65822f70c32Sdrh ** the table has any PRIMARY KEY, INTEGER or otherwise.
65922f70c32Sdrh **
660d24cc427Sdrh ** Table.tnum is the page number for the root BTree page of the table in the
661d24cc427Sdrh ** database file.  If Table.iDb is the index of the database table backend
662d24cc427Sdrh ** in sqlite.aDb[].  0 is for the main database and 1 is for the file that
663d24cc427Sdrh ** holds temporary tables and indices.  If Table.isTransient
66422f70c32Sdrh ** is true, then the table is stored in a file that is automatically deleted
665d24cc427Sdrh ** when the VDBE cursor to the table is closed.  In this case Table.tnum
66622f70c32Sdrh ** refers VDBE cursor number that holds the table open, not to the root
66722f70c32Sdrh ** page number.  Transient tables are used to hold the results of a
66822f70c32Sdrh ** sub-query that appears instead of a real table name in the FROM clause
66922f70c32Sdrh ** of a SELECT statement.
67075897234Sdrh */
67175897234Sdrh struct Table {
67275897234Sdrh   char *zName;     /* Name of the table */
67375897234Sdrh   int nCol;        /* Number of columns in this table */
6747020f651Sdrh   Column *aCol;    /* Information about each column */
675c8392586Sdrh   int iPKey;       /* If not less then 0, use aCol[iPKey] as the primary key */
676967e8b73Sdrh   Index *pIndex;   /* List of SQL indexes on this table. */
67722f70c32Sdrh   int tnum;        /* Root BTree node for this table (see note above) */
678a76b5dfcSdrh   Select *pSelect; /* NULL for tables.  Points to definition if a view. */
679717e6402Sdrh   u8 readOnly;     /* True if this table should not be written by the user */
68022f70c32Sdrh   u8 isTransient;  /* True if automatically deleted when VDBE finishes */
6814a32431cSdrh   u8 hasPrimKey;   /* True if there exists a primary key */
6829cfcf5d4Sdrh   u8 keyConf;      /* What to do in case of uniqueness conflict on iPKey */
683205f48e6Sdrh   u8 autoInc;      /* True if the integer primary key is autoincrement */
684ed8a3bb1Sdrh   int nRef;          /* Number of pointers to this Table */
685c3f9bad2Sdanielk1977   Trigger *pTrigger; /* List of SQL triggers on this table */
686c2eef3b3Sdrh   FKey *pFKey;       /* Linked list of all foreign keys in this table */
6873d1bfeaaSdanielk1977   char *zColAff;     /* String defining the affinity of each column */
688ffe07b2dSdrh #ifndef SQLITE_OMIT_CHECK
689ffe07b2dSdrh   Expr *pCheck;      /* The AND of all CHECK constraints */
690ffe07b2dSdrh #endif
69119a8e7e8Sdanielk1977 #ifndef SQLITE_OMIT_ALTERTABLE
69219a8e7e8Sdanielk1977   int addColOffset;  /* Offset in CREATE TABLE statement to add a new column */
69319a8e7e8Sdanielk1977 #endif
694e501b89aSdanielk1977   Schema *pSchema;
69575897234Sdrh };
69675897234Sdrh 
69775897234Sdrh /*
698c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure.
699c2eef3b3Sdrh **
700c2eef3b3Sdrh ** A foreign key is associated with two tables.  The "from" table is
701c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign
702c2eef3b3Sdrh ** key.  The "to" table is the table that is named in the REFERENCES clause.
703c2eef3b3Sdrh ** Consider this example:
704c2eef3b3Sdrh **
705c2eef3b3Sdrh **     CREATE TABLE ex1(
706c2eef3b3Sdrh **       a INTEGER PRIMARY KEY,
707c2eef3b3Sdrh **       b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
708c2eef3b3Sdrh **     );
709c2eef3b3Sdrh **
710c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
711c2eef3b3Sdrh **
712c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure
713c2eef3b3Sdrh ** which is attached to the from-table.  The to-table need not exist when
714c2eef3b3Sdrh ** the from-table is created.  The existance of the to-table is not checked
715c2eef3b3Sdrh ** until an attempt is made to insert data into the from-table.
716c2eef3b3Sdrh **
717ea1ba17cSdrh ** The sqlite.aFKey hash table stores pointers to this structure
718c2eef3b3Sdrh ** given the name of a to-table.  For each to-table, all foreign keys
719c2eef3b3Sdrh ** associated with that table are on a linked list using the FKey.pNextTo
720c2eef3b3Sdrh ** field.
721c2eef3b3Sdrh */
722c2eef3b3Sdrh struct FKey {
723c2eef3b3Sdrh   Table *pFrom;     /* The table that constains the REFERENCES clause */
724c2eef3b3Sdrh   FKey *pNextFrom;  /* Next foreign key in pFrom */
725c2eef3b3Sdrh   char *zTo;        /* Name of table that the key points to */
726c2eef3b3Sdrh   FKey *pNextTo;    /* Next foreign key that points to zTo */
727c2eef3b3Sdrh   int nCol;         /* Number of columns in this key */
728c2eef3b3Sdrh   struct sColMap {  /* Mapping of columns in pFrom to columns in zTo */
729c2eef3b3Sdrh     int iFrom;         /* Index of column in pFrom */
730c2eef3b3Sdrh     char *zCol;        /* Name of column in zTo.  If 0 use PRIMARY KEY */
731c2eef3b3Sdrh   } *aCol;          /* One entry for each of nCol column s */
732c2eef3b3Sdrh   u8 isDeferred;    /* True if constraint checking is deferred till COMMIT */
733c2eef3b3Sdrh   u8 updateConf;    /* How to resolve conflicts that occur on UPDATE */
734c2eef3b3Sdrh   u8 deleteConf;    /* How to resolve conflicts that occur on DELETE */
735c2eef3b3Sdrh   u8 insertConf;    /* How to resolve conflicts that occur on INSERT */
736c2eef3b3Sdrh };
737c2eef3b3Sdrh 
738c2eef3b3Sdrh /*
739c2eef3b3Sdrh ** SQLite supports many different ways to resolve a contraint
74022f70c32Sdrh ** error.  ROLLBACK processing means that a constraint violation
7410bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction
7421c92853dSdrh ** to be rolled back.  ABORT processing means the operation in process
7431c92853dSdrh ** fails and any prior changes from that one operation are backed out,
7441c92853dSdrh ** but the transaction is not rolled back.  FAIL processing means that
7451c92853dSdrh ** the operation in progress stops and returns an error code.  But prior
7461c92853dSdrh ** changes due to the same operation are not backed out and no rollback
7471c92853dSdrh ** occurs.  IGNORE means that the particular row that caused the constraint
7481c92853dSdrh ** error is not inserted or updated.  Processing continues and no error
7491c92853dSdrh ** is returned.  REPLACE means that preexisting database rows that caused
7501c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or
7511c92853dSdrh ** update can proceed.  Processing continues and no error is reported.
7521c92853dSdrh **
753c2eef3b3Sdrh ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
754c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
755c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys.  SETNULL means that the foreign
756c2eef3b3Sdrh ** key is set to NULL.  CASCADE means that a DELETE or UPDATE of the
757c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the
758c2eef3b3Sdrh ** foreign key.
759c2eef3b3Sdrh **
760968af52aSdrh ** The following symbolic values are used to record which type
7611c92853dSdrh ** of action to take.
7629cfcf5d4Sdrh */
7639cfcf5d4Sdrh #define OE_None     0   /* There is no constraint to check */
7641c92853dSdrh #define OE_Rollback 1   /* Fail the operation and rollback the transaction */
7651c92853dSdrh #define OE_Abort    2   /* Back out changes but do no rollback transaction */
7661c92853dSdrh #define OE_Fail     3   /* Stop the operation but leave all prior changes */
7671c92853dSdrh #define OE_Ignore   4   /* Ignore the error. Do not do the INSERT or UPDATE */
7681c92853dSdrh #define OE_Replace  5   /* Delete existing record, then do INSERT or UPDATE */
769c2eef3b3Sdrh 
770c2eef3b3Sdrh #define OE_Restrict 6   /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
771c2eef3b3Sdrh #define OE_SetNull  7   /* Set the foreign key value to NULL */
772c2eef3b3Sdrh #define OE_SetDflt  8   /* Set the foreign key value to its default */
773c2eef3b3Sdrh #define OE_Cascade  9   /* Cascade the changes */
774c2eef3b3Sdrh 
775c2eef3b3Sdrh #define OE_Default  99  /* Do whatever the default action is */
7769cfcf5d4Sdrh 
777d3d39e93Sdrh 
778d3d39e93Sdrh /*
779d3d39e93Sdrh ** An instance of the following structure is passed as the first
780d3d39e93Sdrh ** argument to sqlite3VdbeKeyCompare and is used to control the
781d3d39e93Sdrh ** comparison of the two index keys.
782d3d39e93Sdrh **
783d3d39e93Sdrh ** If the KeyInfo.incrKey value is true and the comparison would
7847e62779aSdrh ** otherwise be equal, then return a result as if the second key
7857e62779aSdrh ** were larger.
786d3d39e93Sdrh */
787d3d39e93Sdrh struct KeyInfo {
788b1bc9531Sdanielk1977   u8 enc;             /* Text encoding - one of the TEXT_Utf* values */
789d3d39e93Sdrh   u8 incrKey;         /* Increase 2nd key by epsilon before comparison */
790d3d39e93Sdrh   int nField;         /* Number of entries in aColl[] */
791d2d4a6b0Sdrh   u8 *aSortOrder;     /* If defined an aSortOrder[i] is true, sort DESC */
792d3d39e93Sdrh   CollSeq *aColl[1];  /* Collating sequence for each term of the key */
793d3d39e93Sdrh };
794d3d39e93Sdrh 
7959cfcf5d4Sdrh /*
79666b89c8fSdrh ** Each SQL index is represented in memory by an
79775897234Sdrh ** instance of the following structure.
798967e8b73Sdrh **
799967e8b73Sdrh ** The columns of the table that are to be indexed are described
800967e8b73Sdrh ** by the aiColumn[] field of this structure.  For example, suppose
801967e8b73Sdrh ** we have the following table and index:
802967e8b73Sdrh **
803967e8b73Sdrh **     CREATE TABLE Ex1(c1 int, c2 int, c3 text);
804967e8b73Sdrh **     CREATE INDEX Ex2 ON Ex1(c3,c1);
805967e8b73Sdrh **
806967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are
807967e8b73Sdrh ** three columns in the table.  In the Index structure describing
808967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
809967e8b73Sdrh ** The value of aiColumn is {2, 0}.  aiColumn[0]==2 because the
810967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
811967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in
812967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
813ea1ba17cSdrh **
814ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns
815ea1ba17cSdrh ** must be unique and what to do if they are not.  When Index.onError=OE_None,
816ea1ba17cSdrh ** it means this is not a unique index.  Otherwise it is a unique index
817ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution
818ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique
819ea1ba17cSdrh ** element.
82075897234Sdrh */
82175897234Sdrh struct Index {
82275897234Sdrh   char *zName;     /* Name of this index */
823967e8b73Sdrh   int nColumn;     /* Number of columns in the table used by this index */
824967e8b73Sdrh   int *aiColumn;   /* Which columns are used by this index.  1st is 0 */
8258b3d990bSdrh   unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
826967e8b73Sdrh   Table *pTable;   /* The SQL table being indexed */
827be0072d2Sdrh   int tnum;        /* Page containing root of this index in database file */
8289cfcf5d4Sdrh   u8 onError;      /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
829485b39b4Sdrh   u8 autoIndex;    /* True if is automatically created (ex: by UNIQUE) */
830a37cdde0Sdanielk1977   char *zColAff;   /* String defining the affinity of each column */
83175897234Sdrh   Index *pNext;    /* The next index associated with the same table */
832b3bf556eSdanielk1977   Schema *pSchema; /* Schema containing this index */
833b3bf556eSdanielk1977   u8 *aSortOrder;  /* Array of size Index.nColumn. True==DESC, False==ASC */
834b3bf556eSdanielk1977   char **azColl;   /* Array of collation sequence names for index */
83575897234Sdrh };
83675897234Sdrh 
83775897234Sdrh /*
83875897234Sdrh ** Each token coming out of the lexer is an instance of
8394b59ab5eSdrh ** this structure.  Tokens are also used as part of an expression.
8404efc4754Sdrh **
8414efc4754Sdrh ** Note if Token.z==0 then Token.dyn and Token.n are undefined and
8424efc4754Sdrh ** may contain random values.  Do not make any assuptions about Token.dyn
8434efc4754Sdrh ** and Token.n when Token.z==0.
84475897234Sdrh */
84575897234Sdrh struct Token {
8464c755c0fSdrh   const unsigned char *z; /* Text of the token.  Not NULL-terminated! */
8474b59ab5eSdrh   unsigned dyn  : 1;      /* True for malloced memory, false for static */
8486977fea8Sdrh   unsigned n    : 31;     /* Number of characters in this token */
84975897234Sdrh };
85075897234Sdrh 
85175897234Sdrh /*
85213449892Sdrh ** An instance of this structure contains information needed to generate
85313449892Sdrh ** code for a SELECT that contains aggregate functions.
85413449892Sdrh **
85513449892Sdrh ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
85613449892Sdrh ** pointer to this structure.  The Expr.iColumn field is the index in
85713449892Sdrh ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
85813449892Sdrh ** code for that node.
85913449892Sdrh **
86013449892Sdrh ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
86113449892Sdrh ** original Select structure that describes the SELECT statement.  These
86213449892Sdrh ** fields do not need to be freed when deallocating the AggInfo structure.
86313449892Sdrh */
86413449892Sdrh struct AggInfo {
86513449892Sdrh   u8 directMode;          /* Direct rendering mode means take data directly
86613449892Sdrh                           ** from source tables rather than from accumulators */
86713449892Sdrh   u8 useSortingIdx;       /* In direct mode, reference the sorting index rather
86813449892Sdrh                           ** than the source table */
86913449892Sdrh   int sortingIdx;         /* Cursor number of the sorting index */
87013449892Sdrh   ExprList *pGroupBy;     /* The group by clause */
87113449892Sdrh   int nSortingColumn;     /* Number of columns in the sorting index */
87213449892Sdrh   struct AggInfo_col {    /* For each column used in source tables */
87313449892Sdrh     int iTable;              /* Cursor number of the source table */
87413449892Sdrh     int iColumn;             /* Column number within the source table */
87513449892Sdrh     int iSorterColumn;       /* Column number in the sorting index */
87613449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
8775774b806Sdrh     Expr *pExpr;             /* The original expression */
87813449892Sdrh   } *aCol;
87913449892Sdrh   int nColumn;            /* Number of used entries in aCol[] */
88013449892Sdrh   int nColumnAlloc;       /* Number of slots allocated for aCol[] */
88113449892Sdrh   int nAccumulator;       /* Number of columns that show through to the output.
88213449892Sdrh                           ** Additional columns are used only as parameters to
88313449892Sdrh                           ** aggregate functions */
88413449892Sdrh   struct AggInfo_func {   /* For each aggregate function */
88513449892Sdrh     Expr *pExpr;             /* Expression encoding the function */
88613449892Sdrh     FuncDef *pFunc;          /* The aggregate function implementation */
88713449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
888fd357974Sdrh     int iDistinct;           /* Virtual table used to enforce DISTINCT */
88913449892Sdrh   } *aFunc;
89013449892Sdrh   int nFunc;              /* Number of entries in aFunc[] */
89113449892Sdrh   int nFuncAlloc;         /* Number of slots allocated for aFunc[] */
89213449892Sdrh };
89313449892Sdrh 
89413449892Sdrh /*
89575897234Sdrh ** Each node of an expression in the parse tree is an instance
89622f70c32Sdrh ** of this structure.
89722f70c32Sdrh **
89822f70c32Sdrh ** Expr.op is the opcode.  The integer parser token codes are reused
89922f70c32Sdrh ** as opcodes here.  For example, the parser defines TK_GE to be an integer
90022f70c32Sdrh ** code representing the ">=" operator.  This same integer code is reused
90122f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression
90222f70c32Sdrh ** tree.
90322f70c32Sdrh **
90422f70c32Sdrh ** Expr.pRight and Expr.pLeft are subexpressions.  Expr.pList is a list
90522f70c32Sdrh ** of argument if the expression is a function.
90622f70c32Sdrh **
9074b59ab5eSdrh ** Expr.token is the operator token for this node.  For some expressions
9084b59ab5eSdrh ** that have subexpressions, Expr.token can be the complete text that gave
9094b59ab5eSdrh ** rise to the Expr.  In the latter case, the token is marked as being
9104b59ab5eSdrh ** a compound token.
91122f70c32Sdrh **
91222f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table.
91322f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
91422f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and
91522f70c32Sdrh ** Expr.iColumn is the column number for the specific column.  If the
91622f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the
91722f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that
91822f70c32Sdrh ** it can be accessed after all aggregates are computed.
91922f70c32Sdrh **
92022f70c32Sdrh ** If the expression is a function, the Expr.iTable is an integer code
9217c972decSdrh ** representing which function.  If the expression is an unbound variable
9227c972decSdrh ** marker (a question mark character '?' in the original SQL) then the
9237c972decSdrh ** Expr.iTable holds the index number for that variable.
92422f70c32Sdrh **
9251398ad36Sdrh ** If the expression is a subquery then Expr.iColumn holds an integer
9261398ad36Sdrh ** register number containing the result of the subquery.  If the
9271398ad36Sdrh ** subquery gives a constant result, then iTable is -1.  If the subquery
9281398ad36Sdrh ** gives a different answer at different times during statement processing
9291398ad36Sdrh ** then iTable is the address of a subroutine that computes the subquery.
9301398ad36Sdrh **
93122f70c32Sdrh ** The Expr.pSelect field points to a SELECT statement.  The SELECT might
93222f70c32Sdrh ** be the right operand of an IN operator.  Or, if a scalar SELECT appears
93322f70c32Sdrh ** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
93422f70c32Sdrh ** operand.
935aee18ef8Sdanielk1977 **
936aee18ef8Sdanielk1977 ** If the Expr is of type OP_Column, and the table it is selecting from
937aee18ef8Sdanielk1977 ** is a disk table or the "old.*" pseudo-table, then pTab points to the
938aee18ef8Sdanielk1977 ** corresponding table definition.
93975897234Sdrh */
94075897234Sdrh struct Expr {
9411cc093c2Sdrh   u8 op;                 /* Operation performed by this node */
942a9fd84b0Sdrh   char affinity;         /* The affinity of the column or 0 if not a column */
943e22a334bSdrh   u8 flags;              /* Various flags.  See below */
944f2bc013cSdrh   CollSeq *pColl;        /* The collation type of the column or 0 */
94575897234Sdrh   Expr *pLeft, *pRight;  /* Left and right subnodes */
946d99f7068Sdrh   ExprList *pList;       /* A list of expressions used as function arguments
947d99f7068Sdrh                          ** or in "<expr> IN (<expr-list)" */
94875897234Sdrh   Token token;           /* An operand token */
9496977fea8Sdrh   Token span;            /* Complete text of the expression */
950967e8b73Sdrh   int iTable, iColumn;   /* When op==TK_COLUMN, then this expr node means the
9518e2ca029Sdrh                          ** iColumn-th field of the iTable-th table. */
95213449892Sdrh   AggInfo *pAggInfo;     /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
95313449892Sdrh   int iAgg;              /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
95422d6a53aSdrh   int iRightJoinTable;   /* If EP_FromJoin, the right table of the join */
955d99f7068Sdrh   Select *pSelect;       /* When the expression is a sub-select.  Also the
956d99f7068Sdrh                          ** right side of "<expr> IN (<select>)" */
957aee18ef8Sdanielk1977   Table *pTab;           /* Table for OP_Column expressions. */
958e501b89aSdanielk1977   Schema *pSchema;
95975897234Sdrh };
96075897234Sdrh 
96175897234Sdrh /*
9621f16230bSdrh ** The following are the meanings of bits in the Expr.flags field.
9631f16230bSdrh */
964392e597cSdrh #define EP_FromJoin     0x01  /* Originated in ON or USING clause of a join */
965392e597cSdrh #define EP_Agg          0x02  /* Contains one or more aggregate functions */
966392e597cSdrh #define EP_Resolved     0x04  /* IDs have been resolved to COLUMNs */
967392e597cSdrh #define EP_Error        0x08  /* Expression contains one or more errors */
968fd357974Sdrh #define EP_Distinct     0x10  /* Aggregate function with DISTINCT keyword */
969392e597cSdrh #define EP_VarSelect    0x20  /* pSelect is correlated, not constant */
970d2687b77Sdrh #define EP_Dequoted     0x40  /* True if the string has been dequoted */
9711f16230bSdrh 
9721f16230bSdrh /*
9731f16230bSdrh ** These macros can be used to test, set, or clear bits in the
9741f16230bSdrh ** Expr.flags field.
9751f16230bSdrh */
9761f16230bSdrh #define ExprHasProperty(E,P)     (((E)->flags&(P))==(P))
9771f16230bSdrh #define ExprHasAnyProperty(E,P)  (((E)->flags&(P))!=0)
9781f16230bSdrh #define ExprSetProperty(E,P)     (E)->flags|=(P)
9791f16230bSdrh #define ExprClearProperty(E,P)   (E)->flags&=~(P)
9801f16230bSdrh 
9811f16230bSdrh /*
98275897234Sdrh ** A list of expressions.  Each expression may optionally have a
98375897234Sdrh ** name.  An expr/name combination can be used in several ways, such
98475897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the
98575897234Sdrh ** list of "ID = expr" items in an UPDATE.  A list of expressions can
986ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName
98775897234Sdrh ** field is not used.
98875897234Sdrh */
98975897234Sdrh struct ExprList {
99075897234Sdrh   int nExpr;             /* Number of expressions on the list */
9914305d103Sdrh   int nAlloc;            /* Number of entries allocated below */
9929d2985c7Sdrh   int iECursor;          /* VDBE Cursor associated with this ExprList */
9936d4abfbeSdrh   struct ExprList_item {
99475897234Sdrh     Expr *pExpr;           /* The list of expressions */
99575897234Sdrh     char *zName;           /* Token associated with this expression */
9968e2ca029Sdrh     u8 sortOrder;          /* 1 for DESC or 0 for ASC */
9978e2ca029Sdrh     u8 isAgg;              /* True if this is an aggregate like count(*) */
9988e2ca029Sdrh     u8 done;               /* A flag to indicate when processing is finished */
99975897234Sdrh   } *a;                  /* One entry for each expression */
100075897234Sdrh };
100175897234Sdrh 
100275897234Sdrh /*
1003ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers,
1004ad3cab52Sdrh ** such as the list "a,b,c" in the following statements:
1005ad3cab52Sdrh **
1006ad3cab52Sdrh **      INSERT INTO t(a,b,c) VALUES ...;
1007ad3cab52Sdrh **      CREATE INDEX idx ON t(a,b,c);
1008ad3cab52Sdrh **      CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1009ad3cab52Sdrh **
1010ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of
1011ad3cab52Sdrh ** column names after a table name in an INSERT statement.  In the statement
1012ad3cab52Sdrh **
1013ad3cab52Sdrh **     INSERT INTO t(a,b,c) ...
1014ad3cab52Sdrh **
1015ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
101675897234Sdrh */
101775897234Sdrh struct IdList {
10186d4abfbeSdrh   struct IdList_item {
1019ad3cab52Sdrh     char *zName;      /* Name of the identifier */
1020967e8b73Sdrh     int idx;          /* Index in some Table.aCol[] of a column named zName */
1021ad3cab52Sdrh   } *a;
102213449892Sdrh   int nId;         /* Number of identifiers on the list */
102313449892Sdrh   int nAlloc;      /* Number of entries allocated for a[] below */
1024ad3cab52Sdrh };
1025ad3cab52Sdrh 
1026ad3cab52Sdrh /*
102751669863Sdrh ** The bitmask datatype defined below is used for various optimizations.
102851669863Sdrh */
102951669863Sdrh typedef unsigned int Bitmask;
103051669863Sdrh 
103151669863Sdrh /*
1032ad3cab52Sdrh ** The following structure describes the FROM clause of a SELECT statement.
1033ad3cab52Sdrh ** Each table or subquery in the FROM clause is a separate element of
1034ad3cab52Sdrh ** the SrcList.a[] array.
1035d24cc427Sdrh **
1036d24cc427Sdrh ** With the addition of multiple database support, the following structure
1037d24cc427Sdrh ** can also be used to describe a particular table such as the table that
1038d24cc427Sdrh ** is modified by an INSERT, DELETE, or UPDATE statement.  In standard SQL,
1039d24cc427Sdrh ** such a table must be a simple name: ID.  But in SQLite, the table can
1040d24cc427Sdrh ** now be identified by a database name, a dot, then the table name: ID.ID.
1041ad3cab52Sdrh */
1042ad3cab52Sdrh struct SrcList {
1043939a16d6Sdrh   i16 nSrc;        /* Number of tables or subqueries in the FROM clause */
1044939a16d6Sdrh   i16 nAlloc;      /* Number of entries allocated in a[] below */
1045ad3cab52Sdrh   struct SrcList_item {
1046113088ecSdrh     char *zDatabase;  /* Name of database holding this table */
1047ad3cab52Sdrh     char *zName;      /* Name of the table */
1048ad3cab52Sdrh     char *zAlias;     /* The "B" part of a "A AS B" phrase.  zName is the "A" */
1049daffd0e5Sdrh     Table *pTab;      /* An SQL table corresponding to zName */
1050daffd0e5Sdrh     Select *pSelect;  /* A SELECT statement used in place of a table name */
10511787ccabSdanielk1977     u8 isPopulated;   /* Temporary table associated with SELECT is populated */
1052fe05af87Sdrh     u8 jointype;      /* Type of join between this table and the next */
1053fe05af87Sdrh     i16 iCursor;      /* The VDBE cursor number used to access this table */
1054ad3cab52Sdrh     Expr *pOn;        /* The ON clause of a join */
1055ad3cab52Sdrh     IdList *pUsing;   /* The USING clause of a join */
105651669863Sdrh     Bitmask colUsed;  /* Bit N (1<<N) set if column N or pTab is used */
1057113088ecSdrh   } a[1];             /* One entry for each identifier on the list */
105875897234Sdrh };
105975897234Sdrh 
106075897234Sdrh /*
106101f3f253Sdrh ** Permitted values of the SrcList.a.jointype field
106201f3f253Sdrh */
106301f3f253Sdrh #define JT_INNER     0x0001    /* Any kind of inner or cross join */
10643dec223cSdrh #define JT_CROSS     0x0002    /* Explicit use of the CROSS keyword */
10653dec223cSdrh #define JT_NATURAL   0x0004    /* True for a "natural" join */
10663dec223cSdrh #define JT_LEFT      0x0008    /* Left outer join */
10673dec223cSdrh #define JT_RIGHT     0x0010    /* Right outer join */
10683dec223cSdrh #define JT_OUTER     0x0020    /* The "OUTER" keyword is present */
10693dec223cSdrh #define JT_ERROR     0x0040    /* unknown or unsupported join type */
107001f3f253Sdrh 
107101f3f253Sdrh /*
10726b56344dSdrh ** For each nested loop in a WHERE clause implementation, the WhereInfo
10736b56344dSdrh ** structure contains a single instance of this structure.  This structure
10746b56344dSdrh ** is intended to be private the the where.c module and should not be
10756b56344dSdrh ** access or modified by other modules.
10766b56344dSdrh */
10776b56344dSdrh struct WhereLevel {
107829dda4aeSdrh   int iFrom;            /* Which entry in the FROM clause */
107929dda4aeSdrh   int flags;            /* Flags associated with this level */
108051147baaSdrh   int iMem;             /* First memory cell used by this level */
108129dda4aeSdrh   int iLeftJoin;        /* Memory cell used to implement LEFT OUTER JOIN */
10829012bcbcSdrh   Index *pIdx;          /* Index used.  NULL if no index */
10839012bcbcSdrh   int iTabCur;          /* The VDBE cursor used to access the table */
10849012bcbcSdrh   int iIdxCur;          /* The VDBE cursor used to acesss pIdx */
10856b56344dSdrh   int brk;              /* Jump here to break out of the loop */
10866b56344dSdrh   int cont;             /* Jump here to continue with the next loop cycle */
1087ad2d8307Sdrh   int top;              /* First instruction of interior of the loop */
108829dda4aeSdrh   int op, p1, p2;       /* Opcode used to terminate the loop */
108951147baaSdrh   int nEq;              /* Number of == or IN constraints on this loop */
1090e23399fcSdrh   int nIn;              /* Number of IN operators constraining this loop */
1091e23399fcSdrh   int *aInLoop;         /* Loop terminators for IN operators */
10926b56344dSdrh };
10936b56344dSdrh 
10946b56344dSdrh /*
109575897234Sdrh ** The WHERE clause processing routine has two halves.  The
109675897234Sdrh ** first part does the start of the WHERE loop and the second
109775897234Sdrh ** half does the tail of the WHERE loop.  An instance of
109875897234Sdrh ** this structure is returned by the first half and passed
109975897234Sdrh ** into the second half to give some continuity.
110075897234Sdrh */
110175897234Sdrh struct WhereInfo {
110275897234Sdrh   Parse *pParse;
1103ad3cab52Sdrh   SrcList *pTabList;   /* List of tables in the join */
11049012bcbcSdrh   int iTop;            /* The very beginning of the WHERE loop */
110519a775c2Sdrh   int iContinue;       /* Jump here to continue with next record */
110619a775c2Sdrh   int iBreak;          /* Jump here to break out of the loop */
11076b56344dSdrh   int nLevel;          /* Number of nested loop */
11086b56344dSdrh   WhereLevel a[1];     /* Information about each nest loop in the WHERE */
110975897234Sdrh };
111075897234Sdrh 
111175897234Sdrh /*
1112b3bce662Sdanielk1977 ** A NameContext defines a context in which to resolve table and column
1113b3bce662Sdanielk1977 ** names.  The context consists of a list of tables (the pSrcList) field and
1114b3bce662Sdanielk1977 ** a list of named expression (pEList).  The named expression list may
1115b3bce662Sdanielk1977 ** be NULL.  The pSrc corresponds to the FROM clause of a SELECT or
1116b3bce662Sdanielk1977 ** to the table being operated on by INSERT, UPDATE, or DELETE.  The
1117b3bce662Sdanielk1977 ** pEList corresponds to the result set of a SELECT and is NULL for
1118b3bce662Sdanielk1977 ** other statements.
1119b3bce662Sdanielk1977 **
1120b3bce662Sdanielk1977 ** NameContexts can be nested.  When resolving names, the inner-most
1121b3bce662Sdanielk1977 ** context is searched first.  If no match is found, the next outer
1122b3bce662Sdanielk1977 ** context is checked.  If there is still no match, the next context
1123b3bce662Sdanielk1977 ** is checked.  This process continues until either a match is found
1124b3bce662Sdanielk1977 ** or all contexts are check.  When a match is found, the nRef member of
1125b3bce662Sdanielk1977 ** the context containing the match is incremented.
1126b3bce662Sdanielk1977 **
1127b3bce662Sdanielk1977 ** Each subquery gets a new NameContext.  The pNext field points to the
1128b3bce662Sdanielk1977 ** NameContext in the parent query.  Thus the process of scanning the
1129b3bce662Sdanielk1977 ** NameContext list corresponds to searching through successively outer
1130b3bce662Sdanielk1977 ** subqueries looking for a match.
1131b3bce662Sdanielk1977 */
1132b3bce662Sdanielk1977 struct NameContext {
1133b3bce662Sdanielk1977   Parse *pParse;       /* The parser */
1134b3bce662Sdanielk1977   SrcList *pSrcList;   /* One or more tables used to resolve names */
1135b3bce662Sdanielk1977   ExprList *pEList;    /* Optional list of named expressions */
1136b3bce662Sdanielk1977   int nRef;            /* Number of names resolved by this context */
1137b3bce662Sdanielk1977   int nErr;            /* Number of errors encountered while resolving names */
1138b3bce662Sdanielk1977   u8 allowAgg;         /* Aggregate functions allowed here */
113913449892Sdrh   u8 hasAgg;           /* True if aggregates are seen */
114006f6541eSdrh   u8 isCheck;          /* True if resolving names in a CHECK constraint */
1141b3bce662Sdanielk1977   int nDepth;          /* Depth of subquery recursion. 1 for no recursion */
114213449892Sdrh   AggInfo *pAggInfo;   /* Information about aggregates at this level */
1143b3bce662Sdanielk1977   NameContext *pNext;  /* Next outer name context.  NULL for outermost */
1144b3bce662Sdanielk1977 };
1145b3bce662Sdanielk1977 
1146b3bce662Sdanielk1977 /*
11479bb61fe7Sdrh ** An instance of the following structure contains all information
11489bb61fe7Sdrh ** needed to generate code for a single SELECT statement.
1149a76b5dfcSdrh **
1150d11d382cSdrh ** nLimit is set to -1 if there is no LIMIT clause.  nOffset is set to 0.
1151d11d382cSdrh ** If there is a LIMIT clause, the parser sets nLimit to the value of the
1152d11d382cSdrh ** limit and nOffset to the value of the offset (or 0 if there is not
1153d11d382cSdrh ** offset).  But later on, nLimit and nOffset become the memory locations
1154d11d382cSdrh ** in the VDBE that record the limit and offset counters.
11550342b1f5Sdrh **
11560342b1f5Sdrh ** addrOpenVirt[] entries contain the address of OP_OpenVirtual opcodes.
11570342b1f5Sdrh ** These addresses must be stored so that we can go back and fill in
11580342b1f5Sdrh ** the P3_KEYINFO and P2 parameters later.  Neither the KeyInfo nor
11590342b1f5Sdrh ** the number of columns in P2 can be computed at the same time
11600342b1f5Sdrh ** as the OP_OpenVirtual instruction is coded because not
11610342b1f5Sdrh ** enough information about the compound query is known at that point.
11620342b1f5Sdrh ** The KeyInfo for addrOpenVirt[0] and [1] contains collating sequences
11630342b1f5Sdrh ** for the result set.  The KeyInfo for addrOpenVirt[2] contains collating
11640342b1f5Sdrh ** sequences for the ORDER BY clause.
11659bb61fe7Sdrh */
11669bb61fe7Sdrh struct Select {
11679bb61fe7Sdrh   ExprList *pEList;      /* The fields of the result */
11687b58daeaSdrh   u8 op;                 /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
11697b58daeaSdrh   u8 isDistinct;         /* True if the DISTINCT keyword is present */
11700342b1f5Sdrh   u8 isResolved;         /* True once sqlite3SelectResolve() has run. */
11710342b1f5Sdrh   u8 isAgg;              /* True if this is an aggregate query */
11720342b1f5Sdrh   u8 usesVirt;           /* True if uses an OpenVirtual opcode */
11734b14b4d7Sdrh   u8 disallowOrderBy;    /* Do not allow an ORDER BY to be attached if TRUE */
1174ad3cab52Sdrh   SrcList *pSrc;         /* The FROM clause */
11759bb61fe7Sdrh   Expr *pWhere;          /* The WHERE clause */
11769bb61fe7Sdrh   ExprList *pGroupBy;    /* The GROUP BY clause */
11779bb61fe7Sdrh   Expr *pHaving;         /* The HAVING clause */
11789bb61fe7Sdrh   ExprList *pOrderBy;    /* The ORDER BY clause */
1179967e8b73Sdrh   Select *pPrior;        /* Prior select in a compound select statement */
11800342b1f5Sdrh   Select *pRightmost;    /* Right-most select in a compound select statement */
1181a2dc3b1aSdanielk1977   Expr *pLimit;          /* LIMIT expression. NULL means not used. */
1182a2dc3b1aSdanielk1977   Expr *pOffset;         /* OFFSET expression. NULL means not used. */
11837b58daeaSdrh   int iLimit, iOffset;   /* Memory registers holding LIMIT & OFFSET counters */
11840342b1f5Sdrh   int addrOpenVirt[3];   /* OP_OpenVirtual opcodes related to this select */
11859bb61fe7Sdrh };
11869bb61fe7Sdrh 
11879bb61fe7Sdrh /*
1188fef5208cSdrh ** The results of a select can be distributed in several ways.
1189fef5208cSdrh */
119013449892Sdrh #define SRT_Union        1  /* Store result as keys in an index */
119113449892Sdrh #define SRT_Except       2  /* Remove result from a UNION index */
119213449892Sdrh #define SRT_Discard      3  /* Do not save the results anywhere */
1193fef5208cSdrh 
119413449892Sdrh /* The ORDER BY clause is ignored for all of the above */
119513449892Sdrh #define IgnorableOrderby(X) (X<=SRT_Discard)
119613449892Sdrh 
119713449892Sdrh #define SRT_Callback     4  /* Invoke a callback with each row of result */
119813449892Sdrh #define SRT_Mem          5  /* Store result in a memory cell */
119913449892Sdrh #define SRT_Set          6  /* Store non-null results as keys in an index */
1200d49c16eeSdrh #define SRT_Table        7  /* Store result as data with an automatic rowid */
1201d49c16eeSdrh #define SRT_VirtualTab   8  /* Create virtual table and store like SRT_Table */
12029d2985c7Sdrh #define SRT_Subroutine   9  /* Call a subroutine to handle results */
1203ec7429aeSdrh #define SRT_Exists      10  /* Store 1 if the result is not empty */
12042282792aSdrh 
12052282792aSdrh /*
1206f57b3399Sdrh ** An SQL parser context.  A copy of this structure is passed through
1207f57b3399Sdrh ** the parser and down into all the parser action routine in order to
1208f57b3399Sdrh ** carry around information that is global to the entire parse.
1209f1974846Sdrh **
1210f1974846Sdrh ** The structure is divided into two parts.  When the parser and code
1211f1974846Sdrh ** generate call themselves recursively, the first part of the structure
1212f1974846Sdrh ** is constant but the second part is reset at the beginning and end of
1213f1974846Sdrh ** each recursion.
1214c00da105Sdanielk1977 **
1215c00da105Sdanielk1977 ** The nTableLock and aTableLock variables are only used if the shared-cache
1216c00da105Sdanielk1977 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
1217c00da105Sdanielk1977 ** used to store the set of table-locks required by the statement being
1218c00da105Sdanielk1977 ** compiled. Function sqlite3TableLock() is used to add entries to the
1219c00da105Sdanielk1977 ** list.
122075897234Sdrh */
122175897234Sdrh struct Parse {
12229bb575fdSdrh   sqlite3 *db;         /* The main database structure */
12234c504391Sdrh   int rc;              /* Return code from execution */
122475897234Sdrh   char *zErrMsg;       /* An error message */
122575897234Sdrh   Vdbe *pVdbe;         /* An engine for executing database bytecode */
1226836faa48Sdrh   u8 colNamesSet;      /* TRUE after OP_ColumnName has been issued to pVdbe */
1227e0bc4048Sdrh   u8 nameClash;        /* A permanent table name clashes with temp table name */
1228a6ecd338Sdrh   u8 checkSchema;      /* Causes schema cookie check after an error */
1229205f48e6Sdrh   u8 nested;           /* Number of nested calls to the parser/code generator */
123075897234Sdrh   int nErr;            /* Number of errors seen */
1231832508b7Sdrh   int nTab;            /* Number of previously allocated VDBE cursors */
123219a775c2Sdrh   int nMem;            /* Number of memory cells used so far */
1233fef5208cSdrh   int nSet;            /* Number of sets used so far */
1234ffe07b2dSdrh   int ckOffset;        /* Stack offset to data used by CHECK constraints */
123580242055Sdrh   u32 writeMask;       /* Start a write transaction on these databases */
1236fcd35c7bSdrh   u32 cookieMask;      /* Bitmask of schema verified databases */
1237fcd35c7bSdrh   int cookieGoto;      /* Address of OP_Goto to cookie verifier subroutine */
1238fcd35c7bSdrh   int cookieValue[MAX_ATTACHED+2];  /* Values of cookies to verify */
1239c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
1240c00da105Sdanielk1977   int nTableLock;        /* Number of locks in aTableLock */
1241c00da105Sdanielk1977   TableLock *aTableLock; /* Required table locks for shared-cache mode */
1242c00da105Sdanielk1977 #endif
1243f1974846Sdrh 
1244f1974846Sdrh   /* Above is constant between recursions.  Below is reset before and after
1245f1974846Sdrh   ** each recursion */
1246f1974846Sdrh 
1247f1974846Sdrh   int nVar;            /* Number of '?' variables seen in the SQL so far */
1248f1974846Sdrh   int nVarExpr;        /* Number of used slots in apVarExpr[] */
1249f1974846Sdrh   int nVarExprAlloc;   /* Number of allocated slots in apVarExpr[] */
1250f1974846Sdrh   Expr **apVarExpr;    /* Pointers to :aaa and $aaaa wildcard expressions */
1251f1974846Sdrh   u8 explain;          /* True if the EXPLAIN flag is found on the query */
1252f1974846Sdrh   Token sErrToken;     /* The token at which the error occurred */
1253f1974846Sdrh   Token sNameToken;    /* Token with unqualified schema object name */
1254f1974846Sdrh   Token sLastToken;    /* The last token parsed */
1255f1974846Sdrh   const char *zSql;    /* All SQL text */
1256f1974846Sdrh   const char *zTail;   /* All SQL text past the last semicolon parsed */
1257f1974846Sdrh   Table *pNewTable;    /* A table being constructed by CREATE TABLE */
1258f1974846Sdrh   Trigger *pNewTrigger;     /* Trigger under construct by a CREATE TRIGGER */
1259f1974846Sdrh   TriggerStack *trigStack;  /* Trigger actions being coded */
1260f1974846Sdrh   const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
126175897234Sdrh };
126275897234Sdrh 
1263d99bc930Sdanielk1977 /*
126485e2096fSdrh ** An instance of the following structure can be declared on a stack and used
126585e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later.
126685e2096fSdrh */
126785e2096fSdrh struct AuthContext {
126885e2096fSdrh   const char *zAuthContext;   /* Put saved Parse.zAuthContext here */
126985e2096fSdrh   Parse *pParse;              /* The Parse structure */
127085e2096fSdrh };
127185e2096fSdrh 
127285e2096fSdrh /*
1273f0863fe5Sdrh ** Bitfield flags for P2 value in OP_Insert and OP_Delete
1274b0c374ffSrdc */
1275b0c374ffSrdc #define OPFLAG_NCHANGE   1    /* Set to update db->nChange */
1276b0c374ffSrdc #define OPFLAG_LASTROWID 2    /* Set to update db->lastRowid */
127794eb6a14Sdanielk1977 #define OPFLAG_ISUPDATE  4    /* This OP_Insert is an sql UPDATE */
1278b0c374ffSrdc 
1279b0c374ffSrdc /*
1280d99bc930Sdanielk1977  * Each trigger present in the database schema is stored as an instance of
1281d99bc930Sdanielk1977  * struct Trigger.
1282d99bc930Sdanielk1977  *
1283d99bc930Sdanielk1977  * Pointers to instances of struct Trigger are stored in two ways.
12849bb575fdSdrh  * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
1285d99bc930Sdanielk1977  *    database). This allows Trigger structures to be retrieved by name.
1286d99bc930Sdanielk1977  * 2. All triggers associated with a single table form a linked list, using the
1287ad3cab52Sdrh  *    pNext member of struct Trigger. A pointer to the first element of the
1288ad3cab52Sdrh  *    linked list is stored as the "pTrigger" member of the associated
1289ad3cab52Sdrh  *    struct Table.
1290d99bc930Sdanielk1977  *
1291ad3cab52Sdrh  * The "step_list" member points to the first element of a linked list
1292ad3cab52Sdrh  * containing the SQL statements specified as the trigger program.
1293d99bc930Sdanielk1977  */
1294d99bc930Sdanielk1977 struct Trigger {
1295d99bc930Sdanielk1977   char *name;             /* The name of the trigger                        */
1296d99bc930Sdanielk1977   char *table;            /* The table or view to which the trigger applies */
1297f0f258b1Sdrh   u8 op;                  /* One of TK_DELETE, TK_UPDATE, TK_INSERT         */
1298dca76841Sdrh   u8 tr_tm;               /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
1299d99bc930Sdanielk1977   Expr *pWhen;            /* The WHEN clause of the expresion (may be NULL) */
1300d99bc930Sdanielk1977   IdList *pColumns;       /* If this is an UPDATE OF <column-list> trigger,
1301d99bc930Sdanielk1977                              the <column-list> is stored here */
1302d99bc930Sdanielk1977   int foreach;            /* One of TK_ROW or TK_STATEMENT */
13034312db55Sdrh   Token nameToken;        /* Token containing zName. Use during parsing only */
1304e501b89aSdanielk1977   Schema *pSchema;        /* Schema containing the trigger */
1305e501b89aSdanielk1977   Schema *pTabSchema;     /* Schema containing the table */
1306d99bc930Sdanielk1977   TriggerStep *step_list; /* Link list of trigger program steps             */
1307d99bc930Sdanielk1977   Trigger *pNext;         /* Next trigger associated with the table */
1308c3f9bad2Sdanielk1977 };
1309d99bc930Sdanielk1977 
1310d99bc930Sdanielk1977 /*
1311dca76841Sdrh ** A trigger is either a BEFORE or an AFTER trigger.  The following constants
1312dca76841Sdrh ** determine which.
1313dca76841Sdrh **
1314dca76841Sdrh ** If there are multiple triggers, you might of some BEFORE and some AFTER.
1315dca76841Sdrh ** In that cases, the constants below can be ORed together.
1316dca76841Sdrh */
1317dca76841Sdrh #define TRIGGER_BEFORE  1
1318dca76841Sdrh #define TRIGGER_AFTER   2
1319dca76841Sdrh 
1320dca76841Sdrh /*
1321d99bc930Sdanielk1977  * An instance of struct TriggerStep is used to store a single SQL statement
1322d99bc930Sdanielk1977  * that is a part of a trigger-program.
1323d99bc930Sdanielk1977  *
1324d99bc930Sdanielk1977  * Instances of struct TriggerStep are stored in a singly linked list (linked
1325d99bc930Sdanielk1977  * using the "pNext" member) referenced by the "step_list" member of the
1326d99bc930Sdanielk1977  * associated struct Trigger instance. The first element of the linked list is
1327d99bc930Sdanielk1977  * the first step of the trigger-program.
1328d99bc930Sdanielk1977  *
1329d99bc930Sdanielk1977  * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
1330d99bc930Sdanielk1977  * "SELECT" statement. The meanings of the other members is determined by the
1331d99bc930Sdanielk1977  * value of "op" as follows:
1332d99bc930Sdanielk1977  *
1333d99bc930Sdanielk1977  * (op == TK_INSERT)
1334d99bc930Sdanielk1977  * orconf    -> stores the ON CONFLICT algorithm
1335d99bc930Sdanielk1977  * pSelect   -> If this is an INSERT INTO ... SELECT ... statement, then
1336d99bc930Sdanielk1977  *              this stores a pointer to the SELECT statement. Otherwise NULL.
1337d99bc930Sdanielk1977  * target    -> A token holding the name of the table to insert into.
1338d99bc930Sdanielk1977  * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
1339d99bc930Sdanielk1977  *              this stores values to be inserted. Otherwise NULL.
1340d99bc930Sdanielk1977  * pIdList   -> If this is an INSERT INTO ... (<column-names>) VALUES ...
1341ad3cab52Sdrh  *              statement, then this stores the column-names to be
1342ad3cab52Sdrh  *              inserted into.
1343d99bc930Sdanielk1977  *
1344d99bc930Sdanielk1977  * (op == TK_DELETE)
1345d99bc930Sdanielk1977  * target    -> A token holding the name of the table to delete from.
1346d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the DELETE statement if one is specified.
1347d99bc930Sdanielk1977  *              Otherwise NULL.
1348d99bc930Sdanielk1977  *
1349d99bc930Sdanielk1977  * (op == TK_UPDATE)
1350d99bc930Sdanielk1977  * target    -> A token holding the name of the table to update rows of.
1351d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the UPDATE statement if one is specified.
1352d99bc930Sdanielk1977  *              Otherwise NULL.
1353d99bc930Sdanielk1977  * pExprList -> A list of the columns to update and the expressions to update
13544adee20fSdanielk1977  *              them to. See sqlite3Update() documentation of "pChanges"
1355ad3cab52Sdrh  *              argument.
1356d99bc930Sdanielk1977  *
1357d99bc930Sdanielk1977  */
1358c3f9bad2Sdanielk1977 struct TriggerStep {
1359c3f9bad2Sdanielk1977   int op;              /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1360d99bc930Sdanielk1977   int orconf;          /* OE_Rollback etc. */
1361a69d9168Sdrh   Trigger *pTrig;      /* The trigger that this step is a part of */
1362c3f9bad2Sdanielk1977 
1363c3f9bad2Sdanielk1977   Select *pSelect;     /* Valid for SELECT and sometimes
1364c3f9bad2Sdanielk1977 			  INSERT steps (when pExprList == 0) */
1365c3f9bad2Sdanielk1977   Token target;        /* Valid for DELETE, UPDATE, INSERT steps */
1366c3f9bad2Sdanielk1977   Expr *pWhere;        /* Valid for DELETE, UPDATE steps */
1367c3f9bad2Sdanielk1977   ExprList *pExprList; /* Valid for UPDATE statements and sometimes
1368c3f9bad2Sdanielk1977 			   INSERT steps (when pSelect == 0)         */
1369c3f9bad2Sdanielk1977   IdList *pIdList;     /* Valid for INSERT statements only */
1370c3f9bad2Sdanielk1977   TriggerStep *pNext;  /* Next in the link-list */
1371187e4c6aSdrh   TriggerStep *pLast;  /* Last element in link-list. Valid for 1st elem only */
1372c3f9bad2Sdanielk1977 };
1373c3f9bad2Sdanielk1977 
1374d99bc930Sdanielk1977 /*
1375d99bc930Sdanielk1977  * An instance of struct TriggerStack stores information required during code
1376d99bc930Sdanielk1977  * generation of a single trigger program. While the trigger program is being
1377d99bc930Sdanielk1977  * coded, its associated TriggerStack instance is pointed to by the
1378d99bc930Sdanielk1977  * "pTriggerStack" member of the Parse structure.
1379d99bc930Sdanielk1977  *
1380d99bc930Sdanielk1977  * The pTab member points to the table that triggers are being coded on. The
1381d99bc930Sdanielk1977  * newIdx member contains the index of the vdbe cursor that points at the temp
1382d99bc930Sdanielk1977  * table that stores the new.* references. If new.* references are not valid
1383d99bc930Sdanielk1977  * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1384d99bc930Sdanielk1977  * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1385d99bc930Sdanielk1977  *
1386d99bc930Sdanielk1977  * The ON CONFLICT policy to be used for the trigger program steps is stored
1387d99bc930Sdanielk1977  * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1388d99bc930Sdanielk1977  * specified for individual triggers steps is used.
1389d99bc930Sdanielk1977  *
1390d99bc930Sdanielk1977  * struct TriggerStack has a "pNext" member, to allow linked lists to be
1391d99bc930Sdanielk1977  * constructed. When coding nested triggers (triggers fired by other triggers)
1392d99bc930Sdanielk1977  * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1393d99bc930Sdanielk1977  * pointer. Once the nested trigger has been coded, the pNext value is restored
1394d99bc930Sdanielk1977  * to the pTriggerStack member of the Parse stucture and coding of the parent
1395d99bc930Sdanielk1977  * trigger continues.
1396d99bc930Sdanielk1977  *
1397d99bc930Sdanielk1977  * Before a nested trigger is coded, the linked list pointed to by the
1398d99bc930Sdanielk1977  * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1399d99bc930Sdanielk1977  * recursively. If this condition is detected, the nested trigger is not coded.
1400d99bc930Sdanielk1977  */
1401d99bc930Sdanielk1977 struct TriggerStack {
1402d99bc930Sdanielk1977   Table *pTab;         /* Table that triggers are currently being coded on */
1403d99bc930Sdanielk1977   int newIdx;          /* Index of vdbe cursor to "new" temp table */
1404d99bc930Sdanielk1977   int oldIdx;          /* Index of vdbe cursor to "old" temp table */
1405d99bc930Sdanielk1977   int orconf;          /* Current orconf policy */
14066f34903eSdanielk1977   int ignoreJump;      /* where to jump to for a RAISE(IGNORE) */
1407e22a334bSdrh   Trigger *pTrigger;   /* The trigger currently being coded */
1408e22a334bSdrh   TriggerStack *pNext; /* Next trigger down on the trigger stack */
1409c3f9bad2Sdanielk1977 };
1410c3f9bad2Sdanielk1977 
1411d99bc930Sdanielk1977 /*
1412f26e09c8Sdrh ** The following structure contains information used by the sqliteFix...
1413f26e09c8Sdrh ** routines as they walk the parse tree to make database references
1414f26e09c8Sdrh ** explicit.
1415f26e09c8Sdrh */
1416f26e09c8Sdrh typedef struct DbFixer DbFixer;
1417f26e09c8Sdrh struct DbFixer {
1418f26e09c8Sdrh   Parse *pParse;      /* The parsing context.  Error messages written here */
1419f26e09c8Sdrh   const char *zDb;    /* Make sure all objects are contained in this database */
1420f26e09c8Sdrh   const char *zType;  /* Type of the container - used for error messages */
1421f26e09c8Sdrh   const Token *pName; /* Name of the container - used for error messages */
1422f26e09c8Sdrh };
1423f26e09c8Sdrh 
1424f26e09c8Sdrh /*
1425234c39dfSdrh ** A pointer to this structure is used to communicate information
1426234c39dfSdrh ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
1427234c39dfSdrh */
1428234c39dfSdrh typedef struct {
14299bb575fdSdrh   sqlite3 *db;        /* The database being initialized */
1430234c39dfSdrh   char **pzErrMsg;    /* Error message stored here */
1431234c39dfSdrh } InitData;
1432234c39dfSdrh 
1433b6c29897Sdrh /*
1434d99bc930Sdanielk1977  * This global flag is set for performance testing of triggers. When it is set
1435d99bc930Sdanielk1977  * SQLite will perform the overhead of building new and old trigger references
1436d99bc930Sdanielk1977  * even when no triggers exist
1437d99bc930Sdanielk1977  */
143838f8271fSdrh extern int sqlite3_always_code_trigger_setup;
1439c3f9bad2Sdanielk1977 
144075897234Sdrh /*
144149285708Sdrh ** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production
144249285708Sdrh ** builds) or a function call (for debugging).  If it is a function call,
144349285708Sdrh ** it allows the operator to set a breakpoint at the spot where database
144449285708Sdrh ** corruption is first detected.
144549285708Sdrh */
144649285708Sdrh #ifdef SQLITE_DEBUG
144749285708Sdrh   extern int sqlite3Corrupt(void);
144849285708Sdrh # define SQLITE_CORRUPT_BKPT sqlite3Corrupt()
144949285708Sdrh #else
145049285708Sdrh # define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT
145149285708Sdrh #endif
145249285708Sdrh 
145349285708Sdrh /*
145475897234Sdrh ** Internal function prototypes
145575897234Sdrh */
14564adee20fSdanielk1977 int sqlite3StrICmp(const char *, const char *);
14574adee20fSdanielk1977 int sqlite3StrNICmp(const char *, const char *, int);
14584adee20fSdanielk1977 int sqlite3HashNoCase(const char *, int);
14598a6b5411Sdanielk1977 int sqlite3IsNumber(const char*, int*, u8);
14604adee20fSdanielk1977 int sqlite3Compare(const char *, const char *);
14614adee20fSdanielk1977 int sqlite3SortCompare(const char *, const char *);
14624adee20fSdanielk1977 void sqlite3RealToSortable(double r, char *);
14632e588c75Sdanielk1977 
1464750b03e5Sdanielk1977 void *sqlite3Malloc(int,int);
1465750b03e5Sdanielk1977 void *sqlite3MallocRaw(int,int);
1466bdb4383aSdrh void sqlite3Free(void*);
1467bdb4383aSdrh void *sqlite3Realloc(void*,int);
1468bdb4383aSdrh char *sqlite3StrDup(const char*);
1469bdb4383aSdrh char *sqlite3StrNDup(const char*, int);
14704adee20fSdanielk1977 # define sqlite3CheckMemory(a,b)
147153f733c7Sdrh void sqlite3ReallocOrFree(void**,int);
1472998da3a2Sdrh void sqlite3FreeX(void*);
1473132d8d6aSdrh void *sqlite3MallocX(int);
147413f7299bSdanielk1977 int sqlite3AllocSize(void *);
14752e588c75Sdanielk1977 
14764adee20fSdanielk1977 char *sqlite3MPrintf(const char*, ...);
14774adee20fSdanielk1977 char *sqlite3VMPrintf(const char*, va_list);
1478e54ca3feSdrh void sqlite3DebugPrintf(const char*, ...);
1479fe63d1c9Sdrh void *sqlite3TextToPtr(const char*);
148041f5852eSdrh void sqlite3SetString(char **, ...);
14814adee20fSdanielk1977 void sqlite3ErrorMsg(Parse*, const char*, ...);
1482a073384fSdrh void sqlite3ErrorClear(Parse*);
14834adee20fSdanielk1977 void sqlite3Dequote(char*);
1484d2687b77Sdrh void sqlite3DequoteExpr(Expr*);
14852646da7eSdrh int sqlite3KeywordCode(const unsigned char*, int);
14864adee20fSdanielk1977 int sqlite3RunParser(Parse*, const char*, char **);
148780242055Sdrh void sqlite3FinishCoding(Parse*);
1488e4e72072Sdrh Expr *sqlite3Expr(int, Expr*, Expr*, const Token*);
14894e0cff60Sdrh Expr *sqlite3RegisterExpr(Parse*,Token*);
149091bb0eedSdrh Expr *sqlite3ExprAnd(Expr*, Expr*);
14914adee20fSdanielk1977 void sqlite3ExprSpan(Expr*,Token*,Token*);
14924adee20fSdanielk1977 Expr *sqlite3ExprFunction(ExprList*, Token*);
1493fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse*, Expr*);
14944adee20fSdanielk1977 void sqlite3ExprDelete(Expr*);
14954adee20fSdanielk1977 ExprList *sqlite3ExprListAppend(ExprList*,Expr*,Token*);
14964adee20fSdanielk1977 void sqlite3ExprListDelete(ExprList*);
14979bb575fdSdrh int sqlite3Init(sqlite3*, char**);
1498234c39dfSdrh int sqlite3InitCallback(void*, int, char**, char**);
149991cf71b0Sdanielk1977 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
15009bb575fdSdrh void sqlite3ResetInternalSchema(sqlite3*, int);
15014adee20fSdanielk1977 void sqlite3BeginParse(Parse*,int);
15029bb575fdSdrh void sqlite3RollbackInternalChanges(sqlite3*);
15039bb575fdSdrh void sqlite3CommitInternalChanges(sqlite3*);
15044adee20fSdanielk1977 Table *sqlite3ResultSetOfSelect(Parse*,char*,Select*);
1505c00da105Sdanielk1977 void sqlite3OpenMasterTable(Parse *, int);
150674161705Sdrh void sqlite3StartTable(Parse*,Token*,Token*,int,int,int);
15074adee20fSdanielk1977 void sqlite3AddColumn(Parse*,Token*);
15084adee20fSdanielk1977 void sqlite3AddNotNull(Parse*, int);
1509fdd6e85aSdrh void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
1510ffe07b2dSdrh void sqlite3AddCheckConstraint(Parse*, Expr*);
1511487e262fSdrh void sqlite3AddColumnType(Parse*,Token*);
15127977a17fSdanielk1977 void sqlite3AddDefaultValue(Parse*,Expr*);
1513d3d39e93Sdrh void sqlite3AddCollateType(Parse*, const char*, int);
151419a8e7e8Sdanielk1977 void sqlite3EndTable(Parse*,Token*,Token*,Select*);
1515b7f9164eSdrh 
1516b7f9164eSdrh #ifndef SQLITE_OMIT_VIEW
151748dec7e2Sdanielk1977   void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int);
15184adee20fSdanielk1977   int sqlite3ViewGetColumnNames(Parse*,Table*);
1519b7f9164eSdrh #else
1520b7f9164eSdrh # define sqlite3ViewGetColumnNames(A,B) 0
1521b7f9164eSdrh #endif
1522b7f9164eSdrh 
1523a073384fSdrh void sqlite3DropTable(Parse*, SrcList*, int, int);
15249bb575fdSdrh void sqlite3DeleteTable(sqlite3*, Table*);
15254adee20fSdanielk1977 void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
152613449892Sdrh int sqlite3ArrayAllocate(void**,int,int);
15274adee20fSdanielk1977 IdList *sqlite3IdListAppend(IdList*, Token*);
15284adee20fSdanielk1977 int sqlite3IdListIndex(IdList*,const char*);
15294adee20fSdanielk1977 SrcList *sqlite3SrcListAppend(SrcList*, Token*, Token*);
15304adee20fSdanielk1977 void sqlite3SrcListAddAlias(SrcList*, Token*);
15314adee20fSdanielk1977 void sqlite3SrcListAssignCursors(Parse*, SrcList*);
15324adee20fSdanielk1977 void sqlite3IdListDelete(IdList*);
15334adee20fSdanielk1977 void sqlite3SrcListDelete(SrcList*);
15340202b29eSdanielk1977 void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
15354d91a701Sdrh                         Token*, int, int);
15364d91a701Sdrh void sqlite3DropIndex(Parse*, SrcList*, int);
15374adee20fSdanielk1977 void sqlite3AddKeyType(Vdbe*, ExprList*);
15384adee20fSdanielk1977 void sqlite3AddIdxKeyType(Vdbe*, Index*);
1539b3bce662Sdanielk1977 int sqlite3Select(Parse*, Select*, int, int, Select*, int, int*, char *aff);
15404adee20fSdanielk1977 Select *sqlite3SelectNew(ExprList*,SrcList*,Expr*,ExprList*,Expr*,ExprList*,
1541a2dc3b1aSdanielk1977                         int,Expr*,Expr*);
15424adee20fSdanielk1977 void sqlite3SelectDelete(Select*);
15434adee20fSdanielk1977 void sqlite3SelectUnbind(Select*);
15444adee20fSdanielk1977 Table *sqlite3SrcListLookup(Parse*, SrcList*);
15454adee20fSdanielk1977 int sqlite3IsReadOnly(Parse*, Table*, int);
1546c00da105Sdanielk1977 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
15474adee20fSdanielk1977 void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
15484adee20fSdanielk1977 void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
1549f8db1bc0Sdrh WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**);
15504adee20fSdanielk1977 void sqlite3WhereEnd(WhereInfo*);
15514adee20fSdanielk1977 void sqlite3ExprCode(Parse*, Expr*);
155225303780Sdrh void sqlite3ExprCodeAndCache(Parse*, Expr*);
1553f9b596ebSdrh int sqlite3ExprCodeExprList(Parse*, ExprList*);
15544adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
15554adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
1556205f48e6Sdrh void sqlite3NextedParse(Parse*, const char*, ...);
15579bb575fdSdrh Table *sqlite3FindTable(sqlite3*,const char*, const char*);
15584adee20fSdanielk1977 Table *sqlite3LocateTable(Parse*,const char*, const char*);
15599bb575fdSdrh Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
15609bb575fdSdrh void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
15619bb575fdSdrh void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
156274161705Sdrh void sqlite3Vacuum(Parse*);
15639bb575fdSdrh int sqlite3RunVacuum(char**, sqlite3*);
1564a99db3b6Sdrh char *sqlite3NameFromToken(Token*);
15654adee20fSdanielk1977 int sqlite3ExprCheck(Parse*, Expr*, int, int*);
15664adee20fSdanielk1977 int sqlite3ExprCompare(Expr*, Expr*);
1567cce7d176Sdrh int sqliteFuncId(Token*);
1568b3bce662Sdanielk1977 int sqlite3ExprResolveNames(NameContext *, Expr *);
1569a58fdfb1Sdanielk1977 int sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
15705d9a4af9Sdrh int sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
15714adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse*);
15724adee20fSdanielk1977 void sqlite3Randomness(int, void*);
15739bb575fdSdrh void sqlite3RollbackAll(sqlite3*);
15744adee20fSdanielk1977 void sqlite3CodeVerifySchema(Parse*, int);
1575684917c2Sdrh void sqlite3BeginTransaction(Parse*, int);
15764adee20fSdanielk1977 void sqlite3CommitTransaction(Parse*);
15774adee20fSdanielk1977 void sqlite3RollbackTransaction(Parse*);
15784adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr*);
1579eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr*);
15804adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr*, int*);
15814adee20fSdanielk1977 int sqlite3IsRowid(const char*);
15829bb575fdSdrh void sqlite3GenerateRowDelete(sqlite3*, Vdbe*, Table*, int, int);
158374161705Sdrh void sqlite3GenerateRowIndexDelete(Vdbe*, Table*, int, char*);
158451846b56Sdrh void sqlite3GenerateIndexKey(Vdbe*, Index*, int);
15854adee20fSdanielk1977 void sqlite3GenerateConstraintChecks(Parse*,Table*,int,char*,int,int,int,int);
15864adee20fSdanielk1977 void sqlite3CompleteInsertion(Parse*, Table*, int, char*, int, int, int);
1587290c1948Sdrh void sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
15884adee20fSdanielk1977 void sqlite3BeginWriteOperation(Parse*, int, int);
15894adee20fSdanielk1977 Expr *sqlite3ExprDup(Expr*);
15904adee20fSdanielk1977 void sqlite3TokenCopy(Token*, Token*);
15914adee20fSdanielk1977 ExprList *sqlite3ExprListDup(ExprList*);
15924adee20fSdanielk1977 SrcList *sqlite3SrcListDup(SrcList*);
15934adee20fSdanielk1977 IdList *sqlite3IdListDup(IdList*);
15944adee20fSdanielk1977 Select *sqlite3SelectDup(Select*);
15959bb575fdSdrh FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
15969bb575fdSdrh void sqlite3RegisterBuiltinFunctions(sqlite3*);
15979bb575fdSdrh void sqlite3RegisterDateTimeFunctions(sqlite3*);
15989bb575fdSdrh int sqlite3SafetyOn(sqlite3*);
15999bb575fdSdrh int sqlite3SafetyOff(sqlite3*);
16009bb575fdSdrh int sqlite3SafetyCheck(sqlite3*);
16019bb575fdSdrh void sqlite3ChangeCookie(sqlite3*, Vdbe*, int);
1602b7f9164eSdrh 
1603b7f9164eSdrh #ifndef SQLITE_OMIT_TRIGGER
1604ef2cb63eSdanielk1977   void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
1605ef2cb63eSdanielk1977                            int,Expr*,int);
16064adee20fSdanielk1977   void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
16074adee20fSdanielk1977   void sqlite3DropTrigger(Parse*, SrcList*);
160874161705Sdrh   void sqlite3DropTriggerPtr(Parse*, Trigger*);
1609dca76841Sdrh   int sqlite3TriggersExist(Parse*, Table*, int, ExprList*);
16104adee20fSdanielk1977   int sqlite3CodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
16116f34903eSdanielk1977                            int, int);
1612dc379456Sdrh   void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
16134adee20fSdanielk1977   void sqlite3DeleteTriggerStep(TriggerStep*);
16144adee20fSdanielk1977   TriggerStep *sqlite3TriggerSelectStep(Select*);
16154adee20fSdanielk1977   TriggerStep *sqlite3TriggerInsertStep(Token*, IdList*, ExprList*,Select*,int);
16164adee20fSdanielk1977   TriggerStep *sqlite3TriggerUpdateStep(Token*, ExprList*, Expr*, int);
16174adee20fSdanielk1977   TriggerStep *sqlite3TriggerDeleteStep(Token*, Expr*);
16184adee20fSdanielk1977   void sqlite3DeleteTrigger(Trigger*);
1619b7f9164eSdrh   void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
1620b7f9164eSdrh #else
1621b7f9164eSdrh # define sqlite3TriggersExist(A,B,C,D,E,F) 0
1622b7f9164eSdrh # define sqlite3DeleteTrigger(A)
1623cdd536f0Sdrh # define sqlite3DropTriggerPtr(A,B)
1624b7f9164eSdrh # define sqlite3UnlinkAndDeleteTrigger(A,B,C)
1625b7f9164eSdrh # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I) 0
1626b7f9164eSdrh #endif
1627b7f9164eSdrh 
16284adee20fSdanielk1977 int sqlite3JoinType(Parse*, Token*, Token*, Token*);
16290202b29eSdanielk1977 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
16304adee20fSdanielk1977 void sqlite3DeferForeignKey(Parse*, int);
1631ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
16324adee20fSdanielk1977   void sqlite3AuthRead(Parse*,Expr*,SrcList*);
16334adee20fSdanielk1977   int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
16344adee20fSdanielk1977   void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
16354adee20fSdanielk1977   void sqlite3AuthContextPop(AuthContext*);
1636ed6c8671Sdrh #else
16374adee20fSdanielk1977 # define sqlite3AuthRead(a,b,c)
16384adee20fSdanielk1977 # define sqlite3AuthCheck(a,b,c,d,e)    SQLITE_OK
16394adee20fSdanielk1977 # define sqlite3AuthContextPush(a,b,c)
16404adee20fSdanielk1977 # define sqlite3AuthContextPop(a)  ((void)(a))
1641ed6c8671Sdrh #endif
1642f744bb56Sdanielk1977 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
1643f744bb56Sdanielk1977 void sqlite3Detach(Parse*, Expr*);
16449bb575fdSdrh int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
164590f5ecb3Sdrh                        int omitJournal, int nCache, Btree **ppBtree);
16464adee20fSdanielk1977 int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
16474adee20fSdanielk1977 int sqlite3FixSrcList(DbFixer*, SrcList*);
16484adee20fSdanielk1977 int sqlite3FixSelect(DbFixer*, Select*);
16494adee20fSdanielk1977 int sqlite3FixExpr(DbFixer*, Expr*);
16504adee20fSdanielk1977 int sqlite3FixExprList(DbFixer*, ExprList*);
16514adee20fSdanielk1977 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
1652487e262fSdrh int sqlite3AtoF(const char *z, double*);
16536f8a503dSdanielk1977 char *sqlite3_snprintf(int,char*,const char*,...);
1654fec19aadSdrh int sqlite3GetInt32(const char *, int*);
1655fec19aadSdrh int sqlite3FitsIn64Bits(const char *);
16566622cce3Sdanielk1977 int sqlite3utf16ByteLen(const void *pData, int nChar);
16576622cce3Sdanielk1977 int sqlite3utf8CharLen(const char *pData, int nByte);
16584e5ffc5fSdrh int sqlite3ReadUtf8(const unsigned char *);
1659192ac1dcSdanielk1977 int sqlite3PutVarint(unsigned char *, u64);
166090e4d95dSdanielk1977 int sqlite3GetVarint(const unsigned char *, u64 *);
16616d2fb154Sdrh int sqlite3GetVarint32(const unsigned char *, u32 *);
1662192ac1dcSdanielk1977 int sqlite3VarintLen(u64 v);
1663a37cdde0Sdanielk1977 void sqlite3IndexAffinityStr(Vdbe *, Index *);
1664a37cdde0Sdanielk1977 void sqlite3TableAffinityStr(Vdbe *, Table *);
1665e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2);
1666e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
1667bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr);
1668eb2e176aSdrh int sqlite3atoi64(const char*, i64*);
16699bb575fdSdrh void sqlite3Error(sqlite3*, int, const char*,...);
1670cbb18d22Sdanielk1977 void *sqlite3HexToBlob(const char *z);
1671ef2cb63eSdanielk1977 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
1672f20b21c8Sdanielk1977 const char *sqlite3ErrStr(int);
1673d02eb1fdSdanielk1977 int sqlite3ReadUniChar(const char *zStr, int *pOffset, u8 *pEnc, int fold);
16748a41449eSdanielk1977 int sqlite3ReadSchema(Parse *pParse);
16759bb575fdSdrh CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
16760202b29eSdanielk1977 CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
16777cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
16787cedc8d4Sdanielk1977 int sqlite3CheckCollSeq(Parse *, CollSeq *);
16797cedc8d4Sdanielk1977 int sqlite3CheckIndexCollSeq(Parse *, Index *);
1680d8123366Sdanielk1977 int sqlite3CheckObjectName(Parse *, const char *);
1681b28af71aSdanielk1977 void sqlite3VdbeSetChanges(sqlite3 *, int);
1682f4618891Sdanielk1977 void sqlite3utf16Substr(sqlite3_context *,int,sqlite3_value **);
16834e6af134Sdanielk1977 
16844e6af134Sdanielk1977 const void *sqlite3ValueText(sqlite3_value*, u8);
16854e6af134Sdanielk1977 int sqlite3ValueBytes(sqlite3_value*, u8);
1686bfd6cce5Sdanielk1977 void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8, void(*)(void*));
16874e6af134Sdanielk1977 void sqlite3ValueFree(sqlite3_value*);
16884f26bb62Sdrh sqlite3_value *sqlite3ValueNew(void);
1689af9a7c22Sdrh char *sqlite3utf16to8(const void*, int);
1690aee18ef8Sdanielk1977 int sqlite3ValueFromExpr(Expr *, u8, u8, sqlite3_value **);
1691aee18ef8Sdanielk1977 void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
16924e5ffc5fSdrh extern const unsigned char sqlite3UpperToLower[];
1693a0bf2652Sdanielk1977 void sqlite3RootPageMoved(Db*, int, int);
16944343fea2Sdrh void sqlite3Reindex(Parse*, Token*, Token*);
16951f01ec1bSdrh void sqlite3AlterFunctions(sqlite3*);
16969fd2a9a0Sdanielk1977 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
16979fd2a9a0Sdanielk1977 int sqlite3GetToken(const unsigned char *, int *);
16982958a4e6Sdrh void sqlite3NestedParse(Parse*, const char*, ...);
1699d89bd007Sdrh void sqlite3ExpirePreparedStatements(sqlite3*);
1700b3bce662Sdanielk1977 void sqlite3CodeSubselect(Parse *, Expr *);
1701b3bce662Sdanielk1977 int sqlite3SelectResolve(Parse *, Select *, NameContext *);
1702aee18ef8Sdanielk1977 void sqlite3ColumnDefault(Vdbe *, Table *, int);
170319a8e7e8Sdanielk1977 void sqlite3AlterFinishAddColumn(Parse *, Token *);
170419a8e7e8Sdanielk1977 void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
17052e66f0b9Sdrh const char *sqlite3TestErrorName(int);
17064dade037Sdanielk1977 CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int);
17078a51256cSdrh char sqlite3AffinityType(const Token*);
17089f18e8a0Sdrh void sqlite3Analyze(Parse*, Token*, Token*);
1709a4afb65cSdrh int sqlite3InvokeBusyHandler(BusyHandler*);
1710ff2d5ea4Sdrh int sqlite3FindDb(sqlite3*, Token*);
1711497e446dSdrh void sqlite3AnalysisLoad(sqlite3*,int iDB);
171251147baaSdrh void sqlite3DefaultRowEst(Index*);
171355ef4d97Sdrh void sqlite3RegisterLikeFunctions(sqlite3*, int);
1714d64fe2f3Sdrh int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
17156f7adc8aSdrh ThreadData *sqlite3ThreadData(void);
17166f7adc8aSdrh const ThreadData *sqlite3ThreadDataReadOnly(void);
17176f7adc8aSdrh void sqlite3ReleaseThreadData(void);
1718f744bb56Sdanielk1977 void sqlite3AttachFunctions(sqlite3 *);
1719fdd6e85aSdrh void sqlite3MinimumFileFormat(Parse*, int, int);
1720da184236Sdanielk1977 void sqlite3SchemaFree(void *);
1721e501b89aSdanielk1977 Schema *sqlite3SchemaGet(Btree *);
1722e501b89aSdanielk1977 int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
1723b3bf556eSdanielk1977 KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *);
1724771151b6Sdanielk1977 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
1725771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **),
1726771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*));
172754f0198eSdanielk1977 int sqlite3ApiExit(sqlite3 *db, int);
1728d1167393Sdrh int sqlite3MallocFailed(void);
1729d1167393Sdrh void sqlite3FailedMalloc(void);
17308d34dfd6Sdanielk1977 void sqlite3AbortOtherActiveVdbes(sqlite3 *, Vdbe *);
1731ddfb2f03Sdanielk1977 int sqlite3OpenTempDatabase(Parse *);
1732e3026636Sdanielk1977 
1733c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
1734c00da105Sdanielk1977   void sqlite3TableLock(Parse *, int, int, u8, const char *);
1735c00da105Sdanielk1977 #else
1736c00da105Sdanielk1977   #define sqlite3TableLock(v,w,x,y,z)
1737c00da105Sdanielk1977 #endif
1738c00da105Sdanielk1977 
173908659feeSdanielk1977 #ifdef SQLITE_MEMDEBUG
1740d1167393Sdrh   void sqlite3MallocDisallow(void);
1741d1167393Sdrh   void sqlite3MallocAllow(void);
1742d1167393Sdrh   int sqlite3TestMallocFail(void);
174308659feeSdanielk1977 #else
1744c93cc42dSdrh   #define sqlite3TestMallocFail() 0
1745c93cc42dSdrh   #define sqlite3MallocDisallow()
1746c93cc42dSdrh   #define sqlite3MallocAllow()
17472e588c75Sdanielk1977 #endif
17482e588c75Sdanielk1977 
1749750b03e5Sdanielk1977 #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
1750750b03e5Sdanielk1977   void *sqlite3ThreadSafeMalloc(int);
1751750b03e5Sdanielk1977   void sqlite3ThreadSafeFree(void *);
1752750b03e5Sdanielk1977 #else
1753750b03e5Sdanielk1977   #define sqlite3ThreadSafeMalloc sqlite3MallocX
1754750b03e5Sdanielk1977   #define sqlite3ThreadSafeFree sqlite3FreeX
1755750b03e5Sdanielk1977 #endif
1756750b03e5Sdanielk1977 
1757fd9a0a45Sdanielk1977 #ifdef SQLITE_SSE
1758fd9a0a45Sdanielk1977 #include "sseInt.h"
1759fd9a0a45Sdanielk1977 #endif
1760fd9a0a45Sdanielk1977 
1761e3026636Sdanielk1977 #endif
1762