xref: /sqlite-3.40.0/src/sqliteInt.h (revision 8d34dfd6)
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*8d34dfd6Sdanielk1977 ** @(#) $Id: sqliteInt.h,v 1.479 2006/01/24 16:37:58 danielk1977 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 for the SELECT DISTINCT statement and for UNION or EXCEPT
1180bd1f4eaSdrh ** compound queries.  No other SQL database engine (among those tested)
1190bd1f4eaSdrh ** works this way except for OCELOT.  But the SQL92 spec implies that
1200bd1f4eaSdrh ** this is how things should work.
1210bd1f4eaSdrh **
1220bd1f4eaSdrh ** If the following macro is set to 0, then NULLs are indistinct for
1230bd1f4eaSdrh ** SELECT DISTINCT and for UNION.
1240bd1f4eaSdrh */
1250bd1f4eaSdrh #define NULL_ALWAYS_DISTINCT 0
1260bd1f4eaSdrh 
1270bd1f4eaSdrh /*
1280bd1f4eaSdrh ** If the following macro is set to 1, then NULL values are considered
1290bd1f4eaSdrh ** distinct when determining whether or not two entries are the same
1300bd1f4eaSdrh ** in a UNIQUE index.  This is the way PostgreSQL, Oracle, DB2, MySQL,
1310bd1f4eaSdrh ** OCELOT, and Firebird all work.  The SQL92 spec explicitly says this
1320bd1f4eaSdrh ** is the way things are suppose to work.
1330bd1f4eaSdrh **
1340bd1f4eaSdrh ** If the following macro is set to 0, the NULLs are indistinct for
1350bd1f4eaSdrh ** a UNIQUE index.  In this mode, you can only have a single NULL entry
1360bd1f4eaSdrh ** for a column declared UNIQUE.  This is the way Informix and SQL Server
1370bd1f4eaSdrh ** work.
1380bd1f4eaSdrh */
1390bd1f4eaSdrh #define NULL_DISTINCT_FOR_UNIQUE 1
1400bd1f4eaSdrh 
1410bd1f4eaSdrh /*
142665de47aSdrh ** The maximum number of attached databases.  This must be at least 2
143665de47aSdrh ** in order to support the main database file (0) and the file used to
14480242055Sdrh ** hold temporary tables (1).  And it must be less than 32 because
14580242055Sdrh ** we use a bitmask of databases with a u32 in places (for example
14680242055Sdrh ** the Parse.cookieMask field).
147665de47aSdrh */
148665de47aSdrh #define MAX_ATTACHED 10
149665de47aSdrh 
150665de47aSdrh /*
151fa6bc000Sdrh ** The maximum value of a ?nnn wildcard that the parser will accept.
152fa6bc000Sdrh */
153fa6bc000Sdrh #define SQLITE_MAX_VARIABLE_NUMBER 999
154fa6bc000Sdrh 
155fa6bc000Sdrh /*
156d946db00Sdrh ** The "file format" number is an integer that is incremented whenever
157d946db00Sdrh ** the VDBE-level file format changes.  The following macros define the
158d946db00Sdrh ** the default file format for new databases and the maximum file format
159d946db00Sdrh ** that the library can read.
160d946db00Sdrh */
161d946db00Sdrh #define SQLITE_MAX_FILE_FORMAT 4
162d946db00Sdrh #ifndef SQLITE_DEFAULT_FILE_FORMAT
163d946db00Sdrh # define SQLITE_DEFAULT_FILE_FORMAT 4
164d946db00Sdrh #endif
165d946db00Sdrh 
166d946db00Sdrh /*
16749766d6cSdrh ** Provide a default value for TEMP_STORE in case it is not specified
16849766d6cSdrh ** on the command-line
16949766d6cSdrh */
17049766d6cSdrh #ifndef TEMP_STORE
17149766d6cSdrh # define TEMP_STORE 1
17249766d6cSdrh #endif
17349766d6cSdrh 
17449766d6cSdrh /*
175f1974846Sdrh ** GCC does not define the offsetof() macro so we'll have to do it
176f1974846Sdrh ** ourselves.
177f1974846Sdrh */
178f1974846Sdrh #ifndef offsetof
179f1974846Sdrh #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
180f1974846Sdrh #endif
181f1974846Sdrh 
182f1974846Sdrh /*
1835a2c2c20Sdrh ** Integers of known sizes.  These typedefs might change for architectures
1845a2c2c20Sdrh ** where the sizes very.  Preprocessor macros are available so that the
1855a2c2c20Sdrh ** types can be conveniently redefined at compile-type.  Like this:
1865a2c2c20Sdrh **
1875a2c2c20Sdrh **         cc '-DUINTPTR_TYPE=long long int' ...
18841a2b48bSdrh */
1893aac2dd7Sdrh #ifndef UINT64_TYPE
190efad9995Sdrh # if defined(_MSC_VER) || defined(__BORLANDC__)
191efad9995Sdrh #   define UINT64_TYPE unsigned __int64
192efad9995Sdrh # else
1933aac2dd7Sdrh #   define UINT64_TYPE unsigned long long int
1943aac2dd7Sdrh # endif
195efad9995Sdrh #endif
1965a2c2c20Sdrh #ifndef UINT32_TYPE
1975a2c2c20Sdrh # define UINT32_TYPE unsigned int
1985a2c2c20Sdrh #endif
1995a2c2c20Sdrh #ifndef UINT16_TYPE
2005a2c2c20Sdrh # define UINT16_TYPE unsigned short int
2015a2c2c20Sdrh #endif
202939a16d6Sdrh #ifndef INT16_TYPE
203939a16d6Sdrh # define INT16_TYPE short int
204939a16d6Sdrh #endif
2055a2c2c20Sdrh #ifndef UINT8_TYPE
2065a2c2c20Sdrh # define UINT8_TYPE unsigned char
2075a2c2c20Sdrh #endif
208905793e2Sdrh #ifndef INT8_TYPE
209905793e2Sdrh # define INT8_TYPE signed char
210905793e2Sdrh #endif
211efad9995Sdrh #ifndef LONGDOUBLE_TYPE
212efad9995Sdrh # define LONGDOUBLE_TYPE long double
213efad9995Sdrh #endif
214efad9995Sdrh typedef sqlite_int64 i64;          /* 8-byte signed integer */
2153aac2dd7Sdrh typedef UINT64_TYPE u64;           /* 8-byte unsigned integer */
2165a2c2c20Sdrh typedef UINT32_TYPE u32;           /* 4-byte unsigned integer */
2175a2c2c20Sdrh typedef UINT16_TYPE u16;           /* 2-byte unsigned integer */
218939a16d6Sdrh typedef INT16_TYPE i16;            /* 2-byte signed integer */
2195a2c2c20Sdrh typedef UINT8_TYPE u8;             /* 1-byte unsigned integer */
220905793e2Sdrh typedef UINT8_TYPE i8;             /* 1-byte signed integer */
2215a2c2c20Sdrh 
2225a2c2c20Sdrh /*
223bbd42a6dSdrh ** Macros to determine whether the machine is big or little endian,
224bbd42a6dSdrh ** evaluated at runtime.
225bbd42a6dSdrh */
226bbd42a6dSdrh extern const int sqlite3one;
2279c054830Sdrh #define SQLITE_BIGENDIAN    (*(char *)(&sqlite3one)==0)
2289c054830Sdrh #define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
229bbd42a6dSdrh 
230bbd42a6dSdrh /*
23190f5ecb3Sdrh ** An instance of the following structure is used to store the busy-handler
23290f5ecb3Sdrh ** callback for a given sqlite handle.
23390f5ecb3Sdrh **
23490f5ecb3Sdrh ** The sqlite.busyHandler member of the sqlite struct contains the busy
23590f5ecb3Sdrh ** callback for the database handle. Each pager opened via the sqlite
23690f5ecb3Sdrh ** handle is passed a pointer to sqlite.busyHandler. The busy-handler
23790f5ecb3Sdrh ** callback is currently invoked only from within pager.c.
23890f5ecb3Sdrh */
23990f5ecb3Sdrh typedef struct BusyHandler BusyHandler;
24090f5ecb3Sdrh struct BusyHandler {
24190f5ecb3Sdrh   int (*xFunc)(void *,int);  /* The busy callback */
24290f5ecb3Sdrh   void *pArg;                /* First arg to busy callback */
243a4afb65cSdrh   int nBusy;                 /* Incremented with each busy call */
24490f5ecb3Sdrh };
24590f5ecb3Sdrh 
24690f5ecb3Sdrh /*
24790f5ecb3Sdrh ** Defer sourcing vdbe.h and btree.h until after the "u8" and
24890f5ecb3Sdrh ** "BusyHandler typedefs.
249905793e2Sdrh */
250905793e2Sdrh #include "vdbe.h"
2513aac2dd7Sdrh #include "btree.h"
25213f7299bSdanielk1977 #include "pager.h"
253905793e2Sdrh 
254905793e2Sdrh /*
2555a2c2c20Sdrh ** This macro casts a pointer to an integer.  Useful for doing
2565a2c2c20Sdrh ** pointer arithmetic.
2575a2c2c20Sdrh */
2585a2c2c20Sdrh #define Addr(X)  ((uptr)X)
25941a2b48bSdrh 
2602c336549Sdanielk1977 #ifdef SQLITE_MEMDEBUG
26175897234Sdrh /*
2626e142f54Sdrh ** The following global variables are used for testing and debugging
263c00da105Sdanielk1977 ** only.  They only work if SQLITE_MEMDEBUG is defined.
2646e142f54Sdrh */
2656f8a503dSdanielk1977 extern int sqlite3_nMalloc;      /* Number of sqliteMalloc() calls */
2666f8a503dSdanielk1977 extern int sqlite3_nFree;        /* Number of sqliteFree() calls */
2676f8a503dSdanielk1977 extern int sqlite3_iMallocFail;  /* Fail sqliteMalloc() after this many calls */
2684693423bSdrh extern int sqlite3_iMallocReset; /* Set iMallocFail to this when it reaches 0 */
2699e12800dSdanielk1977 
2709e12800dSdanielk1977 
2719e12800dSdanielk1977 extern void *sqlite3_pFirst;         /* Pointer to linked list of allocations */
2729e12800dSdanielk1977 extern int sqlite3_nMaxAlloc;        /* High water mark of ThreadData.nAlloc */
2739e12800dSdanielk1977 extern int sqlite3_mallocDisallowed; /* assert() in sqlite3Malloc() if set */
2749e12800dSdanielk1977 extern int sqlite3_isFail;           /* True if all malloc calls should fail */
2759e12800dSdanielk1977 extern const char *sqlite3_zFile;    /* Filename to associate debug info with */
2769e12800dSdanielk1977 extern int sqlite3_iLine;            /* Line number for debug info */
2779e12800dSdanielk1977 
2789e12800dSdanielk1977 #define ENTER_MALLOC (sqlite3_zFile = __FILE__, sqlite3_iLine = __LINE__)
2792e588c75Sdanielk1977 #define sqliteMalloc(x)          (ENTER_MALLOC, sqlite3Malloc(x))
2802e588c75Sdanielk1977 #define sqliteMallocRaw(x)       (ENTER_MALLOC, sqlite3MallocRaw(x))
2812e588c75Sdanielk1977 #define sqliteRealloc(x,y)       (ENTER_MALLOC, sqlite3Realloc(x,y))
2822e588c75Sdanielk1977 #define sqliteStrDup(x)          (ENTER_MALLOC, sqlite3StrDup(x))
2832e588c75Sdanielk1977 #define sqliteStrNDup(x,y)       (ENTER_MALLOC, sqlite3StrNDup(x,y))
284c00da105Sdanielk1977 #define sqliteReallocOrFree(x,y) (ENTER_MALLOC, sqlite3ReallocOrFree(x,y))
2852e588c75Sdanielk1977 
28697cb2e96Sdanielk1977 #else
28797cb2e96Sdanielk1977 
28897cb2e96Sdanielk1977 #define sqliteMalloc(x)          sqlite3Malloc(x)
28997cb2e96Sdanielk1977 #define sqliteMallocRaw(x)       sqlite3MallocRaw(x)
29097cb2e96Sdanielk1977 #define sqliteRealloc(x,y)       sqlite3Realloc(x,y)
29197cb2e96Sdanielk1977 #define sqliteStrDup(x)          sqlite3StrDup(x)
29297cb2e96Sdanielk1977 #define sqliteStrNDup(x,y)       sqlite3StrNDup(x,y)
293c00da105Sdanielk1977 #define sqliteReallocOrFree(x,y) sqlite3ReallocOrFree(x,y)
29497cb2e96Sdanielk1977 
29597cb2e96Sdanielk1977 #endif
29697cb2e96Sdanielk1977 
29797cb2e96Sdanielk1977 #define sqliteFree(x)          sqlite3FreeX(x)
29813f7299bSdanielk1977 #define sqliteAllocSize(x)     sqlite3AllocSize(x)
29997cb2e96Sdanielk1977 
300e7259296Sdanielk1977 
3012e588c75Sdanielk1977 /*
3026f7adc8aSdrh ** An instance of this structure might be allocated to store information
3036f7adc8aSdrh ** specific to a single thread.
3042e588c75Sdanielk1977 */
305e501b89aSdanielk1977 struct ThreadData {
3066dc1d95dSdrh   int dummy;               /* So that this structure is never empty */
3075591df55Sdanielk1977 
3086f7adc8aSdrh #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
309d2d4a6b0Sdrh   int nSoftHeapLimit;      /* Suggested max mem allocation.  No limit if <0 */
310d2d4a6b0Sdrh   int nAlloc;              /* Number of bytes currently allocated */
31113f7299bSdanielk1977   Pager *pPager;           /* Linked list of all pagers in this thread */
3127ddad969Sdanielk1977 #endif
3137ddad969Sdanielk1977 
314aef0bf64Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
315aef0bf64Sdanielk1977   u8 useSharedData;        /* True if shared pagers and schemas are enabled */
316d78901daSdrh   BtShared *pBtree;        /* Linked list of all currently open BTrees */
317aef0bf64Sdanielk1977 #endif
3182e588c75Sdanielk1977 };
3192e588c75Sdanielk1977 
3206e142f54Sdrh /*
32175897234Sdrh ** Name of the master database table.  The master database table
32275897234Sdrh ** is a special table that holds the names and attributes of all
32375897234Sdrh ** user tables and indices.
32475897234Sdrh */
32575897234Sdrh #define MASTER_NAME       "sqlite_master"
326e0bc4048Sdrh #define TEMP_MASTER_NAME  "sqlite_temp_master"
32775897234Sdrh 
32875897234Sdrh /*
3298e150818Sdanielk1977 ** The root-page of the master database table.
3308e150818Sdanielk1977 */
3318e150818Sdanielk1977 #define MASTER_ROOT       1
3328e150818Sdanielk1977 
3338e150818Sdanielk1977 /*
334ed6c8671Sdrh ** The name of the schema table.
335ed6c8671Sdrh */
33653c0f748Sdanielk1977 #define SCHEMA_TABLE(x)  ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
337ed6c8671Sdrh 
338ed6c8671Sdrh /*
33975897234Sdrh ** A convenience macro that returns the number of elements in
34075897234Sdrh ** an array.
34175897234Sdrh */
34275897234Sdrh #define ArraySize(X)    (sizeof(X)/sizeof(X[0]))
34375897234Sdrh 
34475897234Sdrh /*
34575897234Sdrh ** Forward references to structures
34675897234Sdrh */
34713449892Sdrh typedef struct AggInfo AggInfo;
348fe05af87Sdrh typedef struct AuthContext AuthContext;
349fe05af87Sdrh typedef struct CollSeq CollSeq;
3507020f651Sdrh typedef struct Column Column;
351fe05af87Sdrh typedef struct Db Db;
352e501b89aSdanielk1977 typedef struct Schema Schema;
35375897234Sdrh typedef struct Expr Expr;
35475897234Sdrh typedef struct ExprList ExprList;
355c2eef3b3Sdrh typedef struct FKey FKey;
356fe05af87Sdrh typedef struct FuncDef FuncDef;
357fe05af87Sdrh typedef struct IdList IdList;
358fe05af87Sdrh typedef struct Index Index;
3598d059845Sdanielk1977 typedef struct KeyClass KeyClass;
360d3d39e93Sdrh typedef struct KeyInfo KeyInfo;
361626a879aSdrh typedef struct NameContext NameContext;
362fe05af87Sdrh typedef struct Parse Parse;
363fe05af87Sdrh typedef struct Select Select;
364fe05af87Sdrh typedef struct SrcList SrcList;
365e501b89aSdanielk1977 typedef struct ThreadData ThreadData;
366fe05af87Sdrh typedef struct Table Table;
367c00da105Sdanielk1977 typedef struct TableLock TableLock;
368fe05af87Sdrh typedef struct Token Token;
369fe05af87Sdrh typedef struct TriggerStack TriggerStack;
370fe05af87Sdrh typedef struct TriggerStep TriggerStep;
371fe05af87Sdrh typedef struct Trigger Trigger;
372fe05af87Sdrh typedef struct WhereInfo WhereInfo;
373fe05af87Sdrh typedef struct WhereLevel WhereLevel;
374d3d39e93Sdrh 
375001bbcbbSdrh /*
376001bbcbbSdrh ** Each database file to be accessed by the system is an instance
377001bbcbbSdrh ** of the following structure.  There are normally two of these structures
378001bbcbbSdrh ** in the sqlite.aDb[] array.  aDb[0] is the main database file and
379a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables.  Additional
380a69d9168Sdrh ** databases may be attached.
381001bbcbbSdrh */
382001bbcbbSdrh struct Db {
383001bbcbbSdrh   char *zName;         /* Name of this database */
384001bbcbbSdrh   Btree *pBt;          /* The B*Tree structure for this database file */
385da184236Sdanielk1977   u8 inTrans;          /* 0: not writable.  1: Transaction.  2: Checkpoint */
386da184236Sdanielk1977   u8 safety_level;     /* How aggressive at synching data to disk */
387da184236Sdanielk1977   void *pAux;               /* Auxiliary data.  Usually NULL */
388da184236Sdanielk1977   void (*xFreeAux)(void*);  /* Routine to free pAux */
389e501b89aSdanielk1977   Schema *pSchema;     /* Pointer to database schema (possibly shared) */
390da184236Sdanielk1977 };
391da184236Sdanielk1977 
392da184236Sdanielk1977 /*
393da184236Sdanielk1977 ** An instance of the following structure stores a database schema.
394da184236Sdanielk1977 */
395e501b89aSdanielk1977 struct Schema {
396001bbcbbSdrh   int schema_cookie;   /* Database schema version number for this file */
397d24cc427Sdrh   Hash tblHash;        /* All tables indexed by name */
398d24cc427Sdrh   Hash idxHash;        /* All (named) indices indexed by name */
399d24cc427Sdrh   Hash trigHash;       /* All triggers indexed by name */
400d24cc427Sdrh   Hash aFKey;          /* Foreign keys indexed by to-table */
4014794f735Sdrh   Table *pSeqTab;      /* The sqlite_sequence table used by AUTOINCREMENT */
402da184236Sdanielk1977   u8 file_format;      /* Schema format version for this file */
4038079a0d3Sdrh   u8 enc;              /* Text encoding used by this database */
404da184236Sdanielk1977   u16 flags;           /* Flags associated with this schema */
40514db2665Sdanielk1977   int cache_size;      /* Number of pages to use in the cache */
406001bbcbbSdrh };
40775897234Sdrh 
40875897234Sdrh /*
4098bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the
4108bf8dc92Sdrh ** Db.flags field.
4118bf8dc92Sdrh */
412da184236Sdanielk1977 #define DbHasProperty(D,I,P)     (((D)->aDb[I].pSchema->flags&(P))==(P))
413da184236Sdanielk1977 #define DbHasAnyProperty(D,I,P)  (((D)->aDb[I].pSchema->flags&(P))!=0)
414da184236Sdanielk1977 #define DbSetProperty(D,I,P)     (D)->aDb[I].pSchema->flags|=(P)
415da184236Sdanielk1977 #define DbClearProperty(D,I,P)   (D)->aDb[I].pSchema->flags&=~(P)
4168bf8dc92Sdrh 
4178bf8dc92Sdrh /*
4188bf8dc92Sdrh ** Allowed values for the DB.flags field.
4198bf8dc92Sdrh **
4208bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been
4218bf8dc92Sdrh ** read into internal hash tables.
4228bf8dc92Sdrh **
4238bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that
4248bf8dc92Sdrh ** have been filled out.  If the schema changes, these column names might
4258bf8dc92Sdrh ** changes and so the view will need to be reset.
4268bf8dc92Sdrh */
427124b27e6Sdrh #define DB_SchemaLoaded    0x0001  /* The schema has been loaded */
428124b27e6Sdrh #define DB_UnresetViews    0x0002  /* Some views have defined column names */
429b82e7edaSdanielk1977 #define DB_Empty           0x0004  /* The file is empty (length 0 bytes) */
4308bf8dc92Sdrh 
431dc8453fdSdanielk1977 #define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
4328bf8dc92Sdrh 
4338bf8dc92Sdrh /*
434c9b84a1fSdrh ** Each database is an instance of the following structure.
435c9b84a1fSdrh **
436b0c374ffSrdc ** The sqlite.lastRowid records the last insert rowid generated by an
437b0c374ffSrdc ** insert statement.  Inserts on views do not affect its value.  Each
438b0c374ffSrdc ** trigger has its own context, so that lastRowid can be updated inside
439b0c374ffSrdc ** triggers as usual.  The previous value will be restored once the trigger
440b0c374ffSrdc ** exits.  Upon entering a before or instead of trigger, lastRowid is no
441b0c374ffSrdc ** longer (since after version 2.8.12) reset to -1.
442b0c374ffSrdc **
443b0c374ffSrdc ** The sqlite.nChange does not count changes within triggers and keeps no
4446f8a503dSdanielk1977 ** context.  It is reset at start of sqlite3_exec.
445b0c374ffSrdc ** The sqlite.lsChange represents the number of changes made by the last
446b0c374ffSrdc ** insert, update, or delete statement.  It remains constant throughout the
447b0c374ffSrdc ** length of a statement and is then updated by OP_SetCounts.  It keeps a
448b0c374ffSrdc ** context stack just like lastRowid so that the count of changes
449b0c374ffSrdc ** within a trigger is not seen outside the trigger.  Changes to views do not
450b0c374ffSrdc ** affect the value of lsChange.
451b0c374ffSrdc ** The sqlite.csChange keeps track of the number of current changes (since
452b0c374ffSrdc ** the last statement) and is used to update sqlite_lsChange.
4536622cce3Sdanielk1977 **
4546622cce3Sdanielk1977 ** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
4556622cce3Sdanielk1977 ** store the most recent error code and, if applicable, string. The
4566622cce3Sdanielk1977 ** internal function sqlite3Error() is used to set these variables
4576622cce3Sdanielk1977 ** consistently.
45875897234Sdrh */
4599bb575fdSdrh struct sqlite3 {
460001bbcbbSdrh   int nDb;                      /* Number of backends currently in use */
461001bbcbbSdrh   Db *aDb;                      /* All backends */
4628c82b350Sdrh   int flags;                    /* Miscellanous flags. See below */
463fcd35c7bSdrh   int errCode;                  /* Most recent error code (SQLITE_*) */
464fcd35c7bSdrh   u8 autoCommit;                /* The auto-commit flag. */
46590f5ecb3Sdrh   u8 temp_store;                /* 1: file 2: memory 0: default */
4662803757aSdrh   int nTable;                   /* Number of tables in the database */
467d3d39e93Sdrh   CollSeq *pDfltColl;           /* The default collating sequence (BINARY) */
468f328bc80Sdrh   i64 lastRowid;                /* ROWID of most recent insert (see above) */
469f328bc80Sdrh   i64 priorNewRowid;            /* Last randomly generated ROWID */
470247be43dSdrh   int magic;                    /* Magic number for detect library misuse */
471b28af71aSdanielk1977   int nChange;                  /* Value returned by sqlite3_changes() */
472b28af71aSdanielk1977   int nTotalChange;             /* Value returned by sqlite3_total_changes() */
4734adee20fSdanielk1977   struct sqlite3InitInfo {      /* Information used during initialization */
4741d85d931Sdrh     int iDb;                    /* When back is being initialized */
4751d85d931Sdrh     int newTnum;                /* Rootpage of table being initialized */
4761d85d931Sdrh     u8 busy;                    /* TRUE if currently initializing */
4771d85d931Sdrh   } init;
478326dce74Sdrh   struct Vdbe *pVdbe;           /* List of active virtual machines */
4791d850a72Sdanielk1977   int activeVdbeCnt;            /* Number of vdbes currently executing */
48018de4824Sdrh   void (*xTrace)(void*,const char*);        /* Trace function */
48118de4824Sdrh   void *pTraceArg;                          /* Argument to the trace function */
48219e2d37fSdrh   void (*xProfile)(void*,const char*,u64);  /* Profiling function */
48319e2d37fSdrh   void *pProfileArg;                        /* Argument to profile function */
484fcd35c7bSdrh   void *pCommitArg;                 /* Argument to xCommitCallback() */
485fcd35c7bSdrh   int (*xCommitCallback)(void*);    /* Invoked at every commit. */
48671fd80bfSdanielk1977   void *pRollbackArg;               /* Argument to xRollbackCallback() */
48771fd80bfSdanielk1977   void (*xRollbackCallback)(void*); /* Invoked at every commit. */
48894eb6a14Sdanielk1977   void *pUpdateArg;
48994eb6a14Sdanielk1977   void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
490fcd35c7bSdrh   void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
491fcd35c7bSdrh   void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
492fcd35c7bSdrh   void *pCollNeededArg;
493fcd35c7bSdrh   sqlite3_value *pErr;          /* Most recent error message */
494fcd35c7bSdrh   char *zErrMsg;                /* Most recent error message (UTF-8 encoded) */
495fcd35c7bSdrh   char *zErrMsg16;              /* Most recent error message (UTF-16 encoded) */
496ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
497e22a334bSdrh   int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
498e22a334bSdrh                                 /* Access authorization function */
499ed6c8671Sdrh   void *pAuthArg;               /* 1st argument to the access auth function */
500ed6c8671Sdrh #endif
501348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
502348bb5d6Sdanielk1977   int (*xProgress)(void *);     /* The progress callback */
503348bb5d6Sdanielk1977   void *pProgressArg;           /* Argument to the progress callback */
504348bb5d6Sdanielk1977   int nProgressOps;             /* Number of opcodes for progress callback */
505348bb5d6Sdanielk1977 #endif
5066b456a2bSdanielk1977 #ifndef SQLITE_OMIT_GLOBALRECOVER
5076b456a2bSdanielk1977   sqlite3 *pNext;               /* Linked list of open db handles. */
5086b456a2bSdanielk1977 #endif
509fcd35c7bSdrh   Hash aFunc;                   /* All functions that can be in SQL exprs */
510fcd35c7bSdrh   Hash aCollSeq;                /* All collating sequences */
511fcd35c7bSdrh   BusyHandler busyHandler;      /* Busy callback */
51297903fefSdrh   int busyTimeout;             /* Busy handler timeout, in msec */
513fcd35c7bSdrh   Db aDbStatic[2];              /* Static space for the 2 default backends */
5147e900abfSdanielk1977 #ifdef SQLITE_SSE
5157e900abfSdanielk1977   sqlite3_stmt *pFetch;         /* Used by SSE to fetch stored statements */
5167e900abfSdanielk1977 #endif
51775897234Sdrh };
51875897234Sdrh 
51914db2665Sdanielk1977 #define ENC(db) ((db)->aDb[0].pSchema->enc)
52014db2665Sdanielk1977 
52175897234Sdrh /*
5228bf8dc92Sdrh ** Possible values for the sqlite.flags and or Db.flags fields.
5238bf8dc92Sdrh **
5248bf8dc92Sdrh ** On sqlite.flags, the SQLITE_InTrans value means that we have
5258bf8dc92Sdrh ** executed a BEGIN.  On Db.flags, SQLITE_InTrans means a statement
5268bf8dc92Sdrh ** transaction is active on that particular database file.
52775897234Sdrh */
5284c504391Sdrh #define SQLITE_VdbeTrace      0x00000001  /* True to trace VDBE execution */
5294c504391Sdrh #define SQLITE_Interrupt      0x00000004  /* Cancel current operation */
530c4a3c779Sdrh #define SQLITE_InTrans        0x00000008  /* True if in a transaction */
5315e00f6c7Sdrh #define SQLITE_InternChanges  0x00000010  /* Uncommitted Hash table changes */
532382c0247Sdrh #define SQLITE_FullColNames   0x00000020  /* Show full column names on SELECT */
533fcabd464Sdrh #define SQLITE_ShortColNames  0x00000040  /* Show short columns names */
534fcabd464Sdrh #define SQLITE_CountRows      0x00000080  /* Count rows changed by INSERT, */
5351bee3d7bSdrh                                           /*   DELETE, or UPDATE and return */
5361bee3d7bSdrh                                           /*   the count using a callback. */
537fcabd464Sdrh #define SQLITE_NullCallback   0x00000100  /* Invoke the callback once if the */
5386a535340Sdrh                                           /*   result set is empty */
53935d4c2f4Sdrh #define SQLITE_SqlTrace       0x00000200  /* Debug print SQL as it executes */
54035d4c2f4Sdrh #define SQLITE_VdbeListing    0x00000400  /* Debug listings of VDBE programs */
541f404083eSdrh #define SQLITE_WriteSchema    0x00000800  /* OK to update SQLITE_MASTER */
5427bec505eSdrh #define SQLITE_NoReadlock     0x00001000  /* Readlocks are omitted when
5437bec505eSdrh                                           ** accessing read-only databases */
5440cd2d4c9Sdrh #define SQLITE_IgnoreChecks   0x00002000  /* Do not enforce check constraints */
545da184236Sdanielk1977 #define SQLITE_ReadUncommitted 0x00004000  /* For shared-cache mode */
546e321c29aSdrh #define SQLITE_LegacyFileFmt  0x00008000  /* Create new databases in format 1 */
54758b9576bSdrh 
54858b9576bSdrh /*
549247be43dSdrh ** Possible values for the sqlite.magic field.
550247be43dSdrh ** The numbers are obtained at random and have no special meaning, other
551247be43dSdrh ** than being distinct from one another.
552247be43dSdrh */
553247be43dSdrh #define SQLITE_MAGIC_OPEN     0xa029a697  /* Database is open */
554247be43dSdrh #define SQLITE_MAGIC_CLOSED   0x9f3c2d33  /* Database is closed */
555247be43dSdrh #define SQLITE_MAGIC_BUSY     0xf03b7906  /* Database currently in use */
556247be43dSdrh #define SQLITE_MAGIC_ERROR    0xb5357930  /* An SQLITE_MISUSE error occurred */
557247be43dSdrh 
558247be43dSdrh /*
5590bce8354Sdrh ** Each SQL function is defined by an instance of the following
5600bce8354Sdrh ** structure.  A pointer to this structure is stored in the sqlite.aFunc
5618e0a2f90Sdrh ** hash table.  When multiple functions have the same name, the hash table
5628e0a2f90Sdrh ** points to a linked list of these structures.
5632803757aSdrh */
5640bce8354Sdrh struct FuncDef {
56555ef4d97Sdrh   i16 nArg;            /* Number of arguments.  -1 means unlimited */
566d8123366Sdanielk1977   u8 iPrefEnc;         /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
56755ef4d97Sdrh   u8 needCollSeq;      /* True if sqlite3GetFuncCollSeq() might be called */
56855ef4d97Sdrh   u8 flags;            /* Some combination of SQLITE_FUNC_* */
5691350b030Sdrh   void *pUserData;     /* User data parameter */
5700bce8354Sdrh   FuncDef *pNext;      /* Next function with same name */
571f9b596ebSdrh   void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
572f9b596ebSdrh   void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
573f9b596ebSdrh   void (*xFinalize)(sqlite3_context*);                /* Aggregate finializer */
57455ef4d97Sdrh   char zName[1];       /* SQL name of the function.  MUST BE LAST */
5758e0a2f90Sdrh };
5762803757aSdrh 
5772803757aSdrh /*
57855ef4d97Sdrh ** Possible values for FuncDef.flags
57955ef4d97Sdrh */
580d64fe2f3Sdrh #define SQLITE_FUNC_LIKE   0x01  /* Candidate for the LIKE optimization */
581d64fe2f3Sdrh #define SQLITE_FUNC_CASE   0x02  /* Case-sensitive LIKE-type function */
58255ef4d97Sdrh 
58355ef4d97Sdrh /*
584967e8b73Sdrh ** information about each column of an SQL table is held in an instance
5857020f651Sdrh ** of this structure.
5867020f651Sdrh */
5877020f651Sdrh struct Column {
5887020f651Sdrh   char *zName;     /* Name of this column */
5897977a17fSdanielk1977   Expr *pDflt;     /* Default value of this column */
590382c0247Sdrh   char *zType;     /* Data type for this column */
591b3bf556eSdanielk1977   char *zColl;     /* Collating sequence.  If NULL, use the default */
5924a32431cSdrh   u8 notNull;      /* True if there is a NOT NULL constraint */
59378100cc9Sdrh   u8 isPrimKey;    /* True if this column is part of the PRIMARY KEY */
594a37cdde0Sdanielk1977   char affinity;   /* One of the SQLITE_AFF_... values */
5957020f651Sdrh };
5967020f651Sdrh 
5977020f651Sdrh /*
598a9fd84b0Sdrh ** A "Collating Sequence" is defined by an instance of the following
5990202b29eSdanielk1977 ** structure. Conceptually, a collating sequence consists of a name and
6000202b29eSdanielk1977 ** a comparison routine that defines the order of that sequence.
601a9fd84b0Sdrh **
6020202b29eSdanielk1977 ** There may two seperate implementations of the collation function, one
6030202b29eSdanielk1977 ** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
6040202b29eSdanielk1977 ** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
6050202b29eSdanielk1977 ** native byte order. When a collation sequence is invoked, SQLite selects
6060202b29eSdanielk1977 ** the version that will require the least expensive encoding
607b3bf556eSdanielk1977 ** translations, if any.
6080202b29eSdanielk1977 **
6090202b29eSdanielk1977 ** The CollSeq.pUser member variable is an extra parameter that passed in
6100202b29eSdanielk1977 ** as the first argument to the UTF-8 comparison function, xCmp.
6110202b29eSdanielk1977 ** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
6120202b29eSdanielk1977 ** xCmp16.
6130202b29eSdanielk1977 **
6140202b29eSdanielk1977 ** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
6150202b29eSdanielk1977 ** collating sequence is undefined.  Indices built on an undefined
6160202b29eSdanielk1977 ** collating sequence may not be read or written.
617a9fd84b0Sdrh */
618a9fd84b0Sdrh struct CollSeq {
6190202b29eSdanielk1977   char *zName;         /* Name of the collating sequence, UTF-8 encoded */
620466be56bSdanielk1977   u8 enc;              /* Text encoding handled by xCmp() */
621d64fe2f3Sdrh   u8 type;             /* One of the SQLITE_COLL_... values below */
622a9fd84b0Sdrh   void *pUser;         /* First argument to xCmp() */
6230202b29eSdanielk1977   int (*xCmp)(void*,int, const void*, int, const void*);
624a9fd84b0Sdrh };
625a9fd84b0Sdrh 
626a9fd84b0Sdrh /*
627d64fe2f3Sdrh ** Allowed values of CollSeq flags:
628d64fe2f3Sdrh */
629d64fe2f3Sdrh #define SQLITE_COLL_BINARY  1  /* The default memcmp() collating sequence */
630d64fe2f3Sdrh #define SQLITE_COLL_NOCASE  2  /* The built-in NOCASE collating sequence */
631d64fe2f3Sdrh #define SQLITE_COLL_REVERSE 3  /* The built-in REVERSE collating sequence */
632d64fe2f3Sdrh #define SQLITE_COLL_USER    0  /* Any other user-defined collating sequence */
633d64fe2f3Sdrh 
634d64fe2f3Sdrh /*
635d3d39e93Sdrh ** A sort order can be either ASC or DESC.
6368e2ca029Sdrh */
6378e2ca029Sdrh #define SQLITE_SO_ASC       0  /* Sort in ascending order */
638d3d39e93Sdrh #define SQLITE_SO_DESC      1  /* Sort in ascending order */
6398e2ca029Sdrh 
6408e2ca029Sdrh /*
641a37cdde0Sdanielk1977 ** Column affinity types.
6428a51256cSdrh **
6438a51256cSdrh ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
6448a51256cSdrh ** 't' for SQLITE_AFF_TEXT.  But we can save a little space and improve
6458a51256cSdrh ** the speed a little by number the values consecutively.
6468a51256cSdrh **
6478a51256cSdrh ** But rather than start with 0 or 1, we begin with 'a'.  That way,
6488a51256cSdrh ** when multiple affinity types are concatenated into a string and
6498a51256cSdrh ** used as the P3 operand, they will be more readable.
6508a51256cSdrh **
6518a51256cSdrh ** Note also that the numeric types are grouped together so that testing
6528a51256cSdrh ** for a numeric type is a single comparison.
653a37cdde0Sdanielk1977 */
6548a51256cSdrh #define SQLITE_AFF_TEXT     'a'
6558a51256cSdrh #define SQLITE_AFF_NONE     'b'
6568a51256cSdrh #define SQLITE_AFF_NUMERIC  'c'
6578a51256cSdrh #define SQLITE_AFF_INTEGER  'd'
6588a51256cSdrh #define SQLITE_AFF_REAL     'e'
659a37cdde0Sdanielk1977 
6608a51256cSdrh #define sqlite3IsNumericAffinity(X)  ((X)>=SQLITE_AFF_NUMERIC)
661a37cdde0Sdanielk1977 
662a37cdde0Sdanielk1977 /*
66322f70c32Sdrh ** Each SQL table is represented in memory by an instance of the
66422f70c32Sdrh ** following structure.
66522f70c32Sdrh **
666d24cc427Sdrh ** Table.zName is the name of the table.  The case of the original
66722f70c32Sdrh ** CREATE TABLE statement is stored, but case is not significant for
66822f70c32Sdrh ** comparisons.
66922f70c32Sdrh **
670d24cc427Sdrh ** Table.nCol is the number of columns in this table.  Table.aCol is a
67122f70c32Sdrh ** pointer to an array of Column structures, one for each column.
67222f70c32Sdrh **
673d24cc427Sdrh ** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
674d24cc427Sdrh ** the column that is that key.   Otherwise Table.iPKey is negative.  Note
67522f70c32Sdrh ** that the datatype of the PRIMARY KEY must be INTEGER for this field to
67622f70c32Sdrh ** be set.  An INTEGER PRIMARY KEY is used as the rowid for each row of
67722f70c32Sdrh ** the table.  If a table has no INTEGER PRIMARY KEY, then a random rowid
678d24cc427Sdrh ** is generated for each row of the table.  Table.hasPrimKey is true if
67922f70c32Sdrh ** the table has any PRIMARY KEY, INTEGER or otherwise.
68022f70c32Sdrh **
681d24cc427Sdrh ** Table.tnum is the page number for the root BTree page of the table in the
682d24cc427Sdrh ** database file.  If Table.iDb is the index of the database table backend
683d24cc427Sdrh ** in sqlite.aDb[].  0 is for the main database and 1 is for the file that
684d24cc427Sdrh ** holds temporary tables and indices.  If Table.isTransient
68522f70c32Sdrh ** is true, then the table is stored in a file that is automatically deleted
686d24cc427Sdrh ** when the VDBE cursor to the table is closed.  In this case Table.tnum
68722f70c32Sdrh ** refers VDBE cursor number that holds the table open, not to the root
68822f70c32Sdrh ** page number.  Transient tables are used to hold the results of a
68922f70c32Sdrh ** sub-query that appears instead of a real table name in the FROM clause
69022f70c32Sdrh ** of a SELECT statement.
69175897234Sdrh */
69275897234Sdrh struct Table {
69375897234Sdrh   char *zName;     /* Name of the table */
69475897234Sdrh   int nCol;        /* Number of columns in this table */
6957020f651Sdrh   Column *aCol;    /* Information about each column */
696c8392586Sdrh   int iPKey;       /* If not less then 0, use aCol[iPKey] as the primary key */
697967e8b73Sdrh   Index *pIndex;   /* List of SQL indexes on this table. */
69822f70c32Sdrh   int tnum;        /* Root BTree node for this table (see note above) */
699a76b5dfcSdrh   Select *pSelect; /* NULL for tables.  Points to definition if a view. */
700717e6402Sdrh   u8 readOnly;     /* True if this table should not be written by the user */
70122f70c32Sdrh   u8 isTransient;  /* True if automatically deleted when VDBE finishes */
7024a32431cSdrh   u8 hasPrimKey;   /* True if there exists a primary key */
7039cfcf5d4Sdrh   u8 keyConf;      /* What to do in case of uniqueness conflict on iPKey */
704205f48e6Sdrh   u8 autoInc;      /* True if the integer primary key is autoincrement */
705ed8a3bb1Sdrh   int nRef;          /* Number of pointers to this Table */
706c3f9bad2Sdanielk1977   Trigger *pTrigger; /* List of SQL triggers on this table */
707c2eef3b3Sdrh   FKey *pFKey;       /* Linked list of all foreign keys in this table */
7083d1bfeaaSdanielk1977   char *zColAff;     /* String defining the affinity of each column */
709ffe07b2dSdrh #ifndef SQLITE_OMIT_CHECK
710ffe07b2dSdrh   Expr *pCheck;      /* The AND of all CHECK constraints */
711ffe07b2dSdrh #endif
71219a8e7e8Sdanielk1977 #ifndef SQLITE_OMIT_ALTERTABLE
71319a8e7e8Sdanielk1977   int addColOffset;  /* Offset in CREATE TABLE statement to add a new column */
71419a8e7e8Sdanielk1977 #endif
715e501b89aSdanielk1977   Schema *pSchema;
71675897234Sdrh };
71775897234Sdrh 
71875897234Sdrh /*
719c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure.
720c2eef3b3Sdrh **
721c2eef3b3Sdrh ** A foreign key is associated with two tables.  The "from" table is
722c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign
723c2eef3b3Sdrh ** key.  The "to" table is the table that is named in the REFERENCES clause.
724c2eef3b3Sdrh ** Consider this example:
725c2eef3b3Sdrh **
726c2eef3b3Sdrh **     CREATE TABLE ex1(
727c2eef3b3Sdrh **       a INTEGER PRIMARY KEY,
728c2eef3b3Sdrh **       b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
729c2eef3b3Sdrh **     );
730c2eef3b3Sdrh **
731c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
732c2eef3b3Sdrh **
733c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure
734c2eef3b3Sdrh ** which is attached to the from-table.  The to-table need not exist when
735c2eef3b3Sdrh ** the from-table is created.  The existance of the to-table is not checked
736c2eef3b3Sdrh ** until an attempt is made to insert data into the from-table.
737c2eef3b3Sdrh **
738ea1ba17cSdrh ** The sqlite.aFKey hash table stores pointers to this structure
739c2eef3b3Sdrh ** given the name of a to-table.  For each to-table, all foreign keys
740c2eef3b3Sdrh ** associated with that table are on a linked list using the FKey.pNextTo
741c2eef3b3Sdrh ** field.
742c2eef3b3Sdrh */
743c2eef3b3Sdrh struct FKey {
744c2eef3b3Sdrh   Table *pFrom;     /* The table that constains the REFERENCES clause */
745c2eef3b3Sdrh   FKey *pNextFrom;  /* Next foreign key in pFrom */
746c2eef3b3Sdrh   char *zTo;        /* Name of table that the key points to */
747c2eef3b3Sdrh   FKey *pNextTo;    /* Next foreign key that points to zTo */
748c2eef3b3Sdrh   int nCol;         /* Number of columns in this key */
749c2eef3b3Sdrh   struct sColMap {  /* Mapping of columns in pFrom to columns in zTo */
750c2eef3b3Sdrh     int iFrom;         /* Index of column in pFrom */
751c2eef3b3Sdrh     char *zCol;        /* Name of column in zTo.  If 0 use PRIMARY KEY */
752c2eef3b3Sdrh   } *aCol;          /* One entry for each of nCol column s */
753c2eef3b3Sdrh   u8 isDeferred;    /* True if constraint checking is deferred till COMMIT */
754c2eef3b3Sdrh   u8 updateConf;    /* How to resolve conflicts that occur on UPDATE */
755c2eef3b3Sdrh   u8 deleteConf;    /* How to resolve conflicts that occur on DELETE */
756c2eef3b3Sdrh   u8 insertConf;    /* How to resolve conflicts that occur on INSERT */
757c2eef3b3Sdrh };
758c2eef3b3Sdrh 
759c2eef3b3Sdrh /*
760c2eef3b3Sdrh ** SQLite supports many different ways to resolve a contraint
76122f70c32Sdrh ** error.  ROLLBACK processing means that a constraint violation
7620bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction
7631c92853dSdrh ** to be rolled back.  ABORT processing means the operation in process
7641c92853dSdrh ** fails and any prior changes from that one operation are backed out,
7651c92853dSdrh ** but the transaction is not rolled back.  FAIL processing means that
7661c92853dSdrh ** the operation in progress stops and returns an error code.  But prior
7671c92853dSdrh ** changes due to the same operation are not backed out and no rollback
7681c92853dSdrh ** occurs.  IGNORE means that the particular row that caused the constraint
7691c92853dSdrh ** error is not inserted or updated.  Processing continues and no error
7701c92853dSdrh ** is returned.  REPLACE means that preexisting database rows that caused
7711c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or
7721c92853dSdrh ** update can proceed.  Processing continues and no error is reported.
7731c92853dSdrh **
774c2eef3b3Sdrh ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
775c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
776c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys.  SETNULL means that the foreign
777c2eef3b3Sdrh ** key is set to NULL.  CASCADE means that a DELETE or UPDATE of the
778c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the
779c2eef3b3Sdrh ** foreign key.
780c2eef3b3Sdrh **
781968af52aSdrh ** The following symbolic values are used to record which type
7821c92853dSdrh ** of action to take.
7839cfcf5d4Sdrh */
7849cfcf5d4Sdrh #define OE_None     0   /* There is no constraint to check */
7851c92853dSdrh #define OE_Rollback 1   /* Fail the operation and rollback the transaction */
7861c92853dSdrh #define OE_Abort    2   /* Back out changes but do no rollback transaction */
7871c92853dSdrh #define OE_Fail     3   /* Stop the operation but leave all prior changes */
7881c92853dSdrh #define OE_Ignore   4   /* Ignore the error. Do not do the INSERT or UPDATE */
7891c92853dSdrh #define OE_Replace  5   /* Delete existing record, then do INSERT or UPDATE */
790c2eef3b3Sdrh 
791c2eef3b3Sdrh #define OE_Restrict 6   /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
792c2eef3b3Sdrh #define OE_SetNull  7   /* Set the foreign key value to NULL */
793c2eef3b3Sdrh #define OE_SetDflt  8   /* Set the foreign key value to its default */
794c2eef3b3Sdrh #define OE_Cascade  9   /* Cascade the changes */
795c2eef3b3Sdrh 
796c2eef3b3Sdrh #define OE_Default  99  /* Do whatever the default action is */
7979cfcf5d4Sdrh 
798d3d39e93Sdrh 
799d3d39e93Sdrh /*
800d3d39e93Sdrh ** An instance of the following structure is passed as the first
801d3d39e93Sdrh ** argument to sqlite3VdbeKeyCompare and is used to control the
802d3d39e93Sdrh ** comparison of the two index keys.
803d3d39e93Sdrh **
804d3d39e93Sdrh ** If the KeyInfo.incrKey value is true and the comparison would
8057e62779aSdrh ** otherwise be equal, then return a result as if the second key
8067e62779aSdrh ** were larger.
807d3d39e93Sdrh */
808d3d39e93Sdrh struct KeyInfo {
809b1bc9531Sdanielk1977   u8 enc;             /* Text encoding - one of the TEXT_Utf* values */
810d3d39e93Sdrh   u8 incrKey;         /* Increase 2nd key by epsilon before comparison */
811d3d39e93Sdrh   int nField;         /* Number of entries in aColl[] */
812d2d4a6b0Sdrh   u8 *aSortOrder;     /* If defined an aSortOrder[i] is true, sort DESC */
813d3d39e93Sdrh   CollSeq *aColl[1];  /* Collating sequence for each term of the key */
814d3d39e93Sdrh };
815d3d39e93Sdrh 
8169cfcf5d4Sdrh /*
81766b89c8fSdrh ** Each SQL index is represented in memory by an
81875897234Sdrh ** instance of the following structure.
819967e8b73Sdrh **
820967e8b73Sdrh ** The columns of the table that are to be indexed are described
821967e8b73Sdrh ** by the aiColumn[] field of this structure.  For example, suppose
822967e8b73Sdrh ** we have the following table and index:
823967e8b73Sdrh **
824967e8b73Sdrh **     CREATE TABLE Ex1(c1 int, c2 int, c3 text);
825967e8b73Sdrh **     CREATE INDEX Ex2 ON Ex1(c3,c1);
826967e8b73Sdrh **
827967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are
828967e8b73Sdrh ** three columns in the table.  In the Index structure describing
829967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
830967e8b73Sdrh ** The value of aiColumn is {2, 0}.  aiColumn[0]==2 because the
831967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
832967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in
833967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
834ea1ba17cSdrh **
835ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns
836ea1ba17cSdrh ** must be unique and what to do if they are not.  When Index.onError=OE_None,
837ea1ba17cSdrh ** it means this is not a unique index.  Otherwise it is a unique index
838ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution
839ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique
840ea1ba17cSdrh ** element.
84175897234Sdrh */
84275897234Sdrh struct Index {
84375897234Sdrh   char *zName;     /* Name of this index */
844967e8b73Sdrh   int nColumn;     /* Number of columns in the table used by this index */
845967e8b73Sdrh   int *aiColumn;   /* Which columns are used by this index.  1st is 0 */
8468b3d990bSdrh   unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
847967e8b73Sdrh   Table *pTable;   /* The SQL table being indexed */
848be0072d2Sdrh   int tnum;        /* Page containing root of this index in database file */
8499cfcf5d4Sdrh   u8 onError;      /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
850485b39b4Sdrh   u8 autoIndex;    /* True if is automatically created (ex: by UNIQUE) */
851a37cdde0Sdanielk1977   char *zColAff;   /* String defining the affinity of each column */
85275897234Sdrh   Index *pNext;    /* The next index associated with the same table */
853b3bf556eSdanielk1977   Schema *pSchema; /* Schema containing this index */
854b3bf556eSdanielk1977   u8 *aSortOrder;  /* Array of size Index.nColumn. True==DESC, False==ASC */
855b3bf556eSdanielk1977   char **azColl;   /* Array of collation sequence names for index */
85675897234Sdrh };
85775897234Sdrh 
85875897234Sdrh /*
85975897234Sdrh ** Each token coming out of the lexer is an instance of
8604b59ab5eSdrh ** this structure.  Tokens are also used as part of an expression.
8614efc4754Sdrh **
8624efc4754Sdrh ** Note if Token.z==0 then Token.dyn and Token.n are undefined and
8634efc4754Sdrh ** may contain random values.  Do not make any assuptions about Token.dyn
8644efc4754Sdrh ** and Token.n when Token.z==0.
86575897234Sdrh */
86675897234Sdrh struct Token {
8674c755c0fSdrh   const unsigned char *z; /* Text of the token.  Not NULL-terminated! */
8684b59ab5eSdrh   unsigned dyn  : 1;      /* True for malloced memory, false for static */
8696977fea8Sdrh   unsigned n    : 31;     /* Number of characters in this token */
87075897234Sdrh };
87175897234Sdrh 
87275897234Sdrh /*
87313449892Sdrh ** An instance of this structure contains information needed to generate
87413449892Sdrh ** code for a SELECT that contains aggregate functions.
87513449892Sdrh **
87613449892Sdrh ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
87713449892Sdrh ** pointer to this structure.  The Expr.iColumn field is the index in
87813449892Sdrh ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
87913449892Sdrh ** code for that node.
88013449892Sdrh **
88113449892Sdrh ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
88213449892Sdrh ** original Select structure that describes the SELECT statement.  These
88313449892Sdrh ** fields do not need to be freed when deallocating the AggInfo structure.
88413449892Sdrh */
88513449892Sdrh struct AggInfo {
88613449892Sdrh   u8 directMode;          /* Direct rendering mode means take data directly
88713449892Sdrh                           ** from source tables rather than from accumulators */
88813449892Sdrh   u8 useSortingIdx;       /* In direct mode, reference the sorting index rather
88913449892Sdrh                           ** than the source table */
89013449892Sdrh   int sortingIdx;         /* Cursor number of the sorting index */
89113449892Sdrh   ExprList *pGroupBy;     /* The group by clause */
89213449892Sdrh   int nSortingColumn;     /* Number of columns in the sorting index */
89313449892Sdrh   struct AggInfo_col {    /* For each column used in source tables */
89413449892Sdrh     int iTable;              /* Cursor number of the source table */
89513449892Sdrh     int iColumn;             /* Column number within the source table */
89613449892Sdrh     int iSorterColumn;       /* Column number in the sorting index */
89713449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
8985774b806Sdrh     Expr *pExpr;             /* The original expression */
89913449892Sdrh   } *aCol;
90013449892Sdrh   int nColumn;            /* Number of used entries in aCol[] */
90113449892Sdrh   int nColumnAlloc;       /* Number of slots allocated for aCol[] */
90213449892Sdrh   int nAccumulator;       /* Number of columns that show through to the output.
90313449892Sdrh                           ** Additional columns are used only as parameters to
90413449892Sdrh                           ** aggregate functions */
90513449892Sdrh   struct AggInfo_func {   /* For each aggregate function */
90613449892Sdrh     Expr *pExpr;             /* Expression encoding the function */
90713449892Sdrh     FuncDef *pFunc;          /* The aggregate function implementation */
90813449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
909fd357974Sdrh     int iDistinct;           /* Virtual table used to enforce DISTINCT */
91013449892Sdrh   } *aFunc;
91113449892Sdrh   int nFunc;              /* Number of entries in aFunc[] */
91213449892Sdrh   int nFuncAlloc;         /* Number of slots allocated for aFunc[] */
91313449892Sdrh };
91413449892Sdrh 
91513449892Sdrh /*
91675897234Sdrh ** Each node of an expression in the parse tree is an instance
91722f70c32Sdrh ** of this structure.
91822f70c32Sdrh **
91922f70c32Sdrh ** Expr.op is the opcode.  The integer parser token codes are reused
92022f70c32Sdrh ** as opcodes here.  For example, the parser defines TK_GE to be an integer
92122f70c32Sdrh ** code representing the ">=" operator.  This same integer code is reused
92222f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression
92322f70c32Sdrh ** tree.
92422f70c32Sdrh **
92522f70c32Sdrh ** Expr.pRight and Expr.pLeft are subexpressions.  Expr.pList is a list
92622f70c32Sdrh ** of argument if the expression is a function.
92722f70c32Sdrh **
9284b59ab5eSdrh ** Expr.token is the operator token for this node.  For some expressions
9294b59ab5eSdrh ** that have subexpressions, Expr.token can be the complete text that gave
9304b59ab5eSdrh ** rise to the Expr.  In the latter case, the token is marked as being
9314b59ab5eSdrh ** a compound token.
93222f70c32Sdrh **
93322f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table.
93422f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
93522f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and
93622f70c32Sdrh ** Expr.iColumn is the column number for the specific column.  If the
93722f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the
93822f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that
93922f70c32Sdrh ** it can be accessed after all aggregates are computed.
94022f70c32Sdrh **
94122f70c32Sdrh ** If the expression is a function, the Expr.iTable is an integer code
9427c972decSdrh ** representing which function.  If the expression is an unbound variable
9437c972decSdrh ** marker (a question mark character '?' in the original SQL) then the
9447c972decSdrh ** Expr.iTable holds the index number for that variable.
94522f70c32Sdrh **
9461398ad36Sdrh ** If the expression is a subquery then Expr.iColumn holds an integer
9471398ad36Sdrh ** register number containing the result of the subquery.  If the
9481398ad36Sdrh ** subquery gives a constant result, then iTable is -1.  If the subquery
9491398ad36Sdrh ** gives a different answer at different times during statement processing
9501398ad36Sdrh ** then iTable is the address of a subroutine that computes the subquery.
9511398ad36Sdrh **
95222f70c32Sdrh ** The Expr.pSelect field points to a SELECT statement.  The SELECT might
95322f70c32Sdrh ** be the right operand of an IN operator.  Or, if a scalar SELECT appears
95422f70c32Sdrh ** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
95522f70c32Sdrh ** operand.
956aee18ef8Sdanielk1977 **
957aee18ef8Sdanielk1977 ** If the Expr is of type OP_Column, and the table it is selecting from
958aee18ef8Sdanielk1977 ** is a disk table or the "old.*" pseudo-table, then pTab points to the
959aee18ef8Sdanielk1977 ** corresponding table definition.
96075897234Sdrh */
96175897234Sdrh struct Expr {
9621cc093c2Sdrh   u8 op;                 /* Operation performed by this node */
963a9fd84b0Sdrh   char affinity;         /* The affinity of the column or 0 if not a column */
964e22a334bSdrh   u8 flags;              /* Various flags.  See below */
965f2bc013cSdrh   CollSeq *pColl;        /* The collation type of the column or 0 */
96675897234Sdrh   Expr *pLeft, *pRight;  /* Left and right subnodes */
967d99f7068Sdrh   ExprList *pList;       /* A list of expressions used as function arguments
968d99f7068Sdrh                          ** or in "<expr> IN (<expr-list)" */
96975897234Sdrh   Token token;           /* An operand token */
9706977fea8Sdrh   Token span;            /* Complete text of the expression */
971967e8b73Sdrh   int iTable, iColumn;   /* When op==TK_COLUMN, then this expr node means the
9728e2ca029Sdrh                          ** iColumn-th field of the iTable-th table. */
97313449892Sdrh   AggInfo *pAggInfo;     /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
97413449892Sdrh   int iAgg;              /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
97522d6a53aSdrh   int iRightJoinTable;   /* If EP_FromJoin, the right table of the join */
976d99f7068Sdrh   Select *pSelect;       /* When the expression is a sub-select.  Also the
977d99f7068Sdrh                          ** right side of "<expr> IN (<select>)" */
978aee18ef8Sdanielk1977   Table *pTab;           /* Table for OP_Column expressions. */
979e501b89aSdanielk1977   Schema *pSchema;
98075897234Sdrh };
98175897234Sdrh 
98275897234Sdrh /*
9831f16230bSdrh ** The following are the meanings of bits in the Expr.flags field.
9841f16230bSdrh */
985392e597cSdrh #define EP_FromJoin     0x01  /* Originated in ON or USING clause of a join */
986392e597cSdrh #define EP_Agg          0x02  /* Contains one or more aggregate functions */
987392e597cSdrh #define EP_Resolved     0x04  /* IDs have been resolved to COLUMNs */
988392e597cSdrh #define EP_Error        0x08  /* Expression contains one or more errors */
989fd357974Sdrh #define EP_Distinct     0x10  /* Aggregate function with DISTINCT keyword */
990392e597cSdrh #define EP_VarSelect    0x20  /* pSelect is correlated, not constant */
991d2687b77Sdrh #define EP_Dequoted     0x40  /* True if the string has been dequoted */
9921f16230bSdrh 
9931f16230bSdrh /*
9941f16230bSdrh ** These macros can be used to test, set, or clear bits in the
9951f16230bSdrh ** Expr.flags field.
9961f16230bSdrh */
9971f16230bSdrh #define ExprHasProperty(E,P)     (((E)->flags&(P))==(P))
9981f16230bSdrh #define ExprHasAnyProperty(E,P)  (((E)->flags&(P))!=0)
9991f16230bSdrh #define ExprSetProperty(E,P)     (E)->flags|=(P)
10001f16230bSdrh #define ExprClearProperty(E,P)   (E)->flags&=~(P)
10011f16230bSdrh 
10021f16230bSdrh /*
100375897234Sdrh ** A list of expressions.  Each expression may optionally have a
100475897234Sdrh ** name.  An expr/name combination can be used in several ways, such
100575897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the
100675897234Sdrh ** list of "ID = expr" items in an UPDATE.  A list of expressions can
1007ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName
100875897234Sdrh ** field is not used.
100975897234Sdrh */
101075897234Sdrh struct ExprList {
101175897234Sdrh   int nExpr;             /* Number of expressions on the list */
10124305d103Sdrh   int nAlloc;            /* Number of entries allocated below */
10139d2985c7Sdrh   int iECursor;          /* VDBE Cursor associated with this ExprList */
10146d4abfbeSdrh   struct ExprList_item {
101575897234Sdrh     Expr *pExpr;           /* The list of expressions */
101675897234Sdrh     char *zName;           /* Token associated with this expression */
10178e2ca029Sdrh     u8 sortOrder;          /* 1 for DESC or 0 for ASC */
10188e2ca029Sdrh     u8 isAgg;              /* True if this is an aggregate like count(*) */
10198e2ca029Sdrh     u8 done;               /* A flag to indicate when processing is finished */
102075897234Sdrh   } *a;                  /* One entry for each expression */
102175897234Sdrh };
102275897234Sdrh 
102375897234Sdrh /*
1024ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers,
1025ad3cab52Sdrh ** such as the list "a,b,c" in the following statements:
1026ad3cab52Sdrh **
1027ad3cab52Sdrh **      INSERT INTO t(a,b,c) VALUES ...;
1028ad3cab52Sdrh **      CREATE INDEX idx ON t(a,b,c);
1029ad3cab52Sdrh **      CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1030ad3cab52Sdrh **
1031ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of
1032ad3cab52Sdrh ** column names after a table name in an INSERT statement.  In the statement
1033ad3cab52Sdrh **
1034ad3cab52Sdrh **     INSERT INTO t(a,b,c) ...
1035ad3cab52Sdrh **
1036ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
103775897234Sdrh */
103875897234Sdrh struct IdList {
10396d4abfbeSdrh   struct IdList_item {
1040ad3cab52Sdrh     char *zName;      /* Name of the identifier */
1041967e8b73Sdrh     int idx;          /* Index in some Table.aCol[] of a column named zName */
1042ad3cab52Sdrh   } *a;
104313449892Sdrh   int nId;         /* Number of identifiers on the list */
104413449892Sdrh   int nAlloc;      /* Number of entries allocated for a[] below */
1045ad3cab52Sdrh };
1046ad3cab52Sdrh 
1047ad3cab52Sdrh /*
104851669863Sdrh ** The bitmask datatype defined below is used for various optimizations.
104951669863Sdrh */
105051669863Sdrh typedef unsigned int Bitmask;
105151669863Sdrh 
105251669863Sdrh /*
1053ad3cab52Sdrh ** The following structure describes the FROM clause of a SELECT statement.
1054ad3cab52Sdrh ** Each table or subquery in the FROM clause is a separate element of
1055ad3cab52Sdrh ** the SrcList.a[] array.
1056d24cc427Sdrh **
1057d24cc427Sdrh ** With the addition of multiple database support, the following structure
1058d24cc427Sdrh ** can also be used to describe a particular table such as the table that
1059d24cc427Sdrh ** is modified by an INSERT, DELETE, or UPDATE statement.  In standard SQL,
1060d24cc427Sdrh ** such a table must be a simple name: ID.  But in SQLite, the table can
1061d24cc427Sdrh ** now be identified by a database name, a dot, then the table name: ID.ID.
1062ad3cab52Sdrh */
1063ad3cab52Sdrh struct SrcList {
1064939a16d6Sdrh   i16 nSrc;        /* Number of tables or subqueries in the FROM clause */
1065939a16d6Sdrh   i16 nAlloc;      /* Number of entries allocated in a[] below */
1066ad3cab52Sdrh   struct SrcList_item {
1067113088ecSdrh     char *zDatabase;  /* Name of database holding this table */
1068ad3cab52Sdrh     char *zName;      /* Name of the table */
1069ad3cab52Sdrh     char *zAlias;     /* The "B" part of a "A AS B" phrase.  zName is the "A" */
1070daffd0e5Sdrh     Table *pTab;      /* An SQL table corresponding to zName */
1071daffd0e5Sdrh     Select *pSelect;  /* A SELECT statement used in place of a table name */
1072fe05af87Sdrh     u8 jointype;      /* Type of join between this table and the next */
1073fe05af87Sdrh     i16 iCursor;      /* The VDBE cursor number used to access this table */
1074ad3cab52Sdrh     Expr *pOn;        /* The ON clause of a join */
1075ad3cab52Sdrh     IdList *pUsing;   /* The USING clause of a join */
107651669863Sdrh     Bitmask colUsed;  /* Bit N (1<<N) set if column N or pTab is used */
1077113088ecSdrh   } a[1];             /* One entry for each identifier on the list */
107875897234Sdrh };
107975897234Sdrh 
108075897234Sdrh /*
108101f3f253Sdrh ** Permitted values of the SrcList.a.jointype field
108201f3f253Sdrh */
108301f3f253Sdrh #define JT_INNER     0x0001    /* Any kind of inner or cross join */
10843dec223cSdrh #define JT_CROSS     0x0002    /* Explicit use of the CROSS keyword */
10853dec223cSdrh #define JT_NATURAL   0x0004    /* True for a "natural" join */
10863dec223cSdrh #define JT_LEFT      0x0008    /* Left outer join */
10873dec223cSdrh #define JT_RIGHT     0x0010    /* Right outer join */
10883dec223cSdrh #define JT_OUTER     0x0020    /* The "OUTER" keyword is present */
10893dec223cSdrh #define JT_ERROR     0x0040    /* unknown or unsupported join type */
109001f3f253Sdrh 
109101f3f253Sdrh /*
10926b56344dSdrh ** For each nested loop in a WHERE clause implementation, the WhereInfo
10936b56344dSdrh ** structure contains a single instance of this structure.  This structure
10946b56344dSdrh ** is intended to be private the the where.c module and should not be
10956b56344dSdrh ** access or modified by other modules.
10966b56344dSdrh */
10976b56344dSdrh struct WhereLevel {
109829dda4aeSdrh   int iFrom;            /* Which entry in the FROM clause */
109929dda4aeSdrh   int flags;            /* Flags associated with this level */
110051147baaSdrh   int iMem;             /* First memory cell used by this level */
110129dda4aeSdrh   int iLeftJoin;        /* Memory cell used to implement LEFT OUTER JOIN */
11029012bcbcSdrh   Index *pIdx;          /* Index used.  NULL if no index */
11039012bcbcSdrh   int iTabCur;          /* The VDBE cursor used to access the table */
11049012bcbcSdrh   int iIdxCur;          /* The VDBE cursor used to acesss pIdx */
11056b56344dSdrh   int brk;              /* Jump here to break out of the loop */
11066b56344dSdrh   int cont;             /* Jump here to continue with the next loop cycle */
1107ad2d8307Sdrh   int top;              /* First instruction of interior of the loop */
110829dda4aeSdrh   int op, p1, p2;       /* Opcode used to terminate the loop */
110951147baaSdrh   int nEq;              /* Number of == or IN constraints on this loop */
1110e23399fcSdrh   int nIn;              /* Number of IN operators constraining this loop */
1111e23399fcSdrh   int *aInLoop;         /* Loop terminators for IN operators */
11126b56344dSdrh };
11136b56344dSdrh 
11146b56344dSdrh /*
111575897234Sdrh ** The WHERE clause processing routine has two halves.  The
111675897234Sdrh ** first part does the start of the WHERE loop and the second
111775897234Sdrh ** half does the tail of the WHERE loop.  An instance of
111875897234Sdrh ** this structure is returned by the first half and passed
111975897234Sdrh ** into the second half to give some continuity.
112075897234Sdrh */
112175897234Sdrh struct WhereInfo {
112275897234Sdrh   Parse *pParse;
1123ad3cab52Sdrh   SrcList *pTabList;   /* List of tables in the join */
11249012bcbcSdrh   int iTop;            /* The very beginning of the WHERE loop */
112519a775c2Sdrh   int iContinue;       /* Jump here to continue with next record */
112619a775c2Sdrh   int iBreak;          /* Jump here to break out of the loop */
11276b56344dSdrh   int nLevel;          /* Number of nested loop */
11286b56344dSdrh   WhereLevel a[1];     /* Information about each nest loop in the WHERE */
112975897234Sdrh };
113075897234Sdrh 
113175897234Sdrh /*
1132b3bce662Sdanielk1977 ** A NameContext defines a context in which to resolve table and column
1133b3bce662Sdanielk1977 ** names.  The context consists of a list of tables (the pSrcList) field and
1134b3bce662Sdanielk1977 ** a list of named expression (pEList).  The named expression list may
1135b3bce662Sdanielk1977 ** be NULL.  The pSrc corresponds to the FROM clause of a SELECT or
1136b3bce662Sdanielk1977 ** to the table being operated on by INSERT, UPDATE, or DELETE.  The
1137b3bce662Sdanielk1977 ** pEList corresponds to the result set of a SELECT and is NULL for
1138b3bce662Sdanielk1977 ** other statements.
1139b3bce662Sdanielk1977 **
1140b3bce662Sdanielk1977 ** NameContexts can be nested.  When resolving names, the inner-most
1141b3bce662Sdanielk1977 ** context is searched first.  If no match is found, the next outer
1142b3bce662Sdanielk1977 ** context is checked.  If there is still no match, the next context
1143b3bce662Sdanielk1977 ** is checked.  This process continues until either a match is found
1144b3bce662Sdanielk1977 ** or all contexts are check.  When a match is found, the nRef member of
1145b3bce662Sdanielk1977 ** the context containing the match is incremented.
1146b3bce662Sdanielk1977 **
1147b3bce662Sdanielk1977 ** Each subquery gets a new NameContext.  The pNext field points to the
1148b3bce662Sdanielk1977 ** NameContext in the parent query.  Thus the process of scanning the
1149b3bce662Sdanielk1977 ** NameContext list corresponds to searching through successively outer
1150b3bce662Sdanielk1977 ** subqueries looking for a match.
1151b3bce662Sdanielk1977 */
1152b3bce662Sdanielk1977 struct NameContext {
1153b3bce662Sdanielk1977   Parse *pParse;       /* The parser */
1154b3bce662Sdanielk1977   SrcList *pSrcList;   /* One or more tables used to resolve names */
1155b3bce662Sdanielk1977   ExprList *pEList;    /* Optional list of named expressions */
1156b3bce662Sdanielk1977   int nRef;            /* Number of names resolved by this context */
1157b3bce662Sdanielk1977   int nErr;            /* Number of errors encountered while resolving names */
1158b3bce662Sdanielk1977   u8 allowAgg;         /* Aggregate functions allowed here */
115913449892Sdrh   u8 hasAgg;           /* True if aggregates are seen */
116006f6541eSdrh   u8 isCheck;          /* True if resolving names in a CHECK constraint */
1161b3bce662Sdanielk1977   int nDepth;          /* Depth of subquery recursion. 1 for no recursion */
116213449892Sdrh   AggInfo *pAggInfo;   /* Information about aggregates at this level */
1163b3bce662Sdanielk1977   NameContext *pNext;  /* Next outer name context.  NULL for outermost */
1164b3bce662Sdanielk1977 };
1165b3bce662Sdanielk1977 
1166b3bce662Sdanielk1977 /*
11679bb61fe7Sdrh ** An instance of the following structure contains all information
11689bb61fe7Sdrh ** needed to generate code for a single SELECT statement.
1169a76b5dfcSdrh **
1170d11d382cSdrh ** nLimit is set to -1 if there is no LIMIT clause.  nOffset is set to 0.
1171d11d382cSdrh ** If there is a LIMIT clause, the parser sets nLimit to the value of the
1172d11d382cSdrh ** limit and nOffset to the value of the offset (or 0 if there is not
1173d11d382cSdrh ** offset).  But later on, nLimit and nOffset become the memory locations
1174d11d382cSdrh ** in the VDBE that record the limit and offset counters.
11750342b1f5Sdrh **
11760342b1f5Sdrh ** addrOpenVirt[] entries contain the address of OP_OpenVirtual opcodes.
11770342b1f5Sdrh ** These addresses must be stored so that we can go back and fill in
11780342b1f5Sdrh ** the P3_KEYINFO and P2 parameters later.  Neither the KeyInfo nor
11790342b1f5Sdrh ** the number of columns in P2 can be computed at the same time
11800342b1f5Sdrh ** as the OP_OpenVirtual instruction is coded because not
11810342b1f5Sdrh ** enough information about the compound query is known at that point.
11820342b1f5Sdrh ** The KeyInfo for addrOpenVirt[0] and [1] contains collating sequences
11830342b1f5Sdrh ** for the result set.  The KeyInfo for addrOpenVirt[2] contains collating
11840342b1f5Sdrh ** sequences for the ORDER BY clause.
11859bb61fe7Sdrh */
11869bb61fe7Sdrh struct Select {
11879bb61fe7Sdrh   ExprList *pEList;      /* The fields of the result */
11887b58daeaSdrh   u8 op;                 /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
11897b58daeaSdrh   u8 isDistinct;         /* True if the DISTINCT keyword is present */
11900342b1f5Sdrh   u8 isResolved;         /* True once sqlite3SelectResolve() has run. */
11910342b1f5Sdrh   u8 isAgg;              /* True if this is an aggregate query */
11920342b1f5Sdrh   u8 usesVirt;           /* True if uses an OpenVirtual opcode */
11934b14b4d7Sdrh   u8 disallowOrderBy;    /* Do not allow an ORDER BY to be attached if TRUE */
1194ad3cab52Sdrh   SrcList *pSrc;         /* The FROM clause */
11959bb61fe7Sdrh   Expr *pWhere;          /* The WHERE clause */
11969bb61fe7Sdrh   ExprList *pGroupBy;    /* The GROUP BY clause */
11979bb61fe7Sdrh   Expr *pHaving;         /* The HAVING clause */
11989bb61fe7Sdrh   ExprList *pOrderBy;    /* The ORDER BY clause */
1199967e8b73Sdrh   Select *pPrior;        /* Prior select in a compound select statement */
12000342b1f5Sdrh   Select *pRightmost;    /* Right-most select in a compound select statement */
1201a2dc3b1aSdanielk1977   Expr *pLimit;          /* LIMIT expression. NULL means not used. */
1202a2dc3b1aSdanielk1977   Expr *pOffset;         /* OFFSET expression. NULL means not used. */
12037b58daeaSdrh   int iLimit, iOffset;   /* Memory registers holding LIMIT & OFFSET counters */
12040342b1f5Sdrh   int addrOpenVirt[3];   /* OP_OpenVirtual opcodes related to this select */
12059bb61fe7Sdrh };
12069bb61fe7Sdrh 
12079bb61fe7Sdrh /*
1208fef5208cSdrh ** The results of a select can be distributed in several ways.
1209fef5208cSdrh */
121013449892Sdrh #define SRT_Union        1  /* Store result as keys in an index */
121113449892Sdrh #define SRT_Except       2  /* Remove result from a UNION index */
121213449892Sdrh #define SRT_Discard      3  /* Do not save the results anywhere */
1213fef5208cSdrh 
121413449892Sdrh /* The ORDER BY clause is ignored for all of the above */
121513449892Sdrh #define IgnorableOrderby(X) (X<=SRT_Discard)
121613449892Sdrh 
121713449892Sdrh #define SRT_Callback     4  /* Invoke a callback with each row of result */
121813449892Sdrh #define SRT_Mem          5  /* Store result in a memory cell */
121913449892Sdrh #define SRT_Set          6  /* Store non-null results as keys in an index */
1220d49c16eeSdrh #define SRT_Table        7  /* Store result as data with an automatic rowid */
1221d49c16eeSdrh #define SRT_VirtualTab   8  /* Create virtual table and store like SRT_Table */
12229d2985c7Sdrh #define SRT_Subroutine   9  /* Call a subroutine to handle results */
1223ec7429aeSdrh #define SRT_Exists      10  /* Store 1 if the result is not empty */
12242282792aSdrh 
12252282792aSdrh /*
1226f57b3399Sdrh ** An SQL parser context.  A copy of this structure is passed through
1227f57b3399Sdrh ** the parser and down into all the parser action routine in order to
1228f57b3399Sdrh ** carry around information that is global to the entire parse.
1229f1974846Sdrh **
1230f1974846Sdrh ** The structure is divided into two parts.  When the parser and code
1231f1974846Sdrh ** generate call themselves recursively, the first part of the structure
1232f1974846Sdrh ** is constant but the second part is reset at the beginning and end of
1233f1974846Sdrh ** each recursion.
1234c00da105Sdanielk1977 **
1235c00da105Sdanielk1977 ** The nTableLock and aTableLock variables are only used if the shared-cache
1236c00da105Sdanielk1977 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
1237c00da105Sdanielk1977 ** used to store the set of table-locks required by the statement being
1238c00da105Sdanielk1977 ** compiled. Function sqlite3TableLock() is used to add entries to the
1239c00da105Sdanielk1977 ** list.
124075897234Sdrh */
124175897234Sdrh struct Parse {
12429bb575fdSdrh   sqlite3 *db;         /* The main database structure */
12434c504391Sdrh   int rc;              /* Return code from execution */
124475897234Sdrh   char *zErrMsg;       /* An error message */
124575897234Sdrh   Vdbe *pVdbe;         /* An engine for executing database bytecode */
1246836faa48Sdrh   u8 colNamesSet;      /* TRUE after OP_ColumnName has been issued to pVdbe */
1247e0bc4048Sdrh   u8 nameClash;        /* A permanent table name clashes with temp table name */
1248a6ecd338Sdrh   u8 checkSchema;      /* Causes schema cookie check after an error */
1249205f48e6Sdrh   u8 nested;           /* Number of nested calls to the parser/code generator */
125075897234Sdrh   int nErr;            /* Number of errors seen */
1251832508b7Sdrh   int nTab;            /* Number of previously allocated VDBE cursors */
125219a775c2Sdrh   int nMem;            /* Number of memory cells used so far */
1253fef5208cSdrh   int nSet;            /* Number of sets used so far */
1254ffe07b2dSdrh   int ckOffset;        /* Stack offset to data used by CHECK constraints */
125580242055Sdrh   u32 writeMask;       /* Start a write transaction on these databases */
1256fcd35c7bSdrh   u32 cookieMask;      /* Bitmask of schema verified databases */
1257fcd35c7bSdrh   int cookieGoto;      /* Address of OP_Goto to cookie verifier subroutine */
1258fcd35c7bSdrh   int cookieValue[MAX_ATTACHED+2];  /* Values of cookies to verify */
1259c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
1260c00da105Sdanielk1977   int nTableLock;        /* Number of locks in aTableLock */
1261c00da105Sdanielk1977   TableLock *aTableLock; /* Required table locks for shared-cache mode */
1262c00da105Sdanielk1977 #endif
1263f1974846Sdrh 
1264f1974846Sdrh   /* Above is constant between recursions.  Below is reset before and after
1265f1974846Sdrh   ** each recursion */
1266f1974846Sdrh 
1267f1974846Sdrh   int nVar;            /* Number of '?' variables seen in the SQL so far */
1268f1974846Sdrh   int nVarExpr;        /* Number of used slots in apVarExpr[] */
1269f1974846Sdrh   int nVarExprAlloc;   /* Number of allocated slots in apVarExpr[] */
1270f1974846Sdrh   Expr **apVarExpr;    /* Pointers to :aaa and $aaaa wildcard expressions */
1271f1974846Sdrh   u8 explain;          /* True if the EXPLAIN flag is found on the query */
1272f1974846Sdrh   Token sErrToken;     /* The token at which the error occurred */
1273f1974846Sdrh   Token sNameToken;    /* Token with unqualified schema object name */
1274f1974846Sdrh   Token sLastToken;    /* The last token parsed */
1275f1974846Sdrh   const char *zSql;    /* All SQL text */
1276f1974846Sdrh   const char *zTail;   /* All SQL text past the last semicolon parsed */
1277f1974846Sdrh   Table *pNewTable;    /* A table being constructed by CREATE TABLE */
1278f1974846Sdrh   Trigger *pNewTrigger;     /* Trigger under construct by a CREATE TRIGGER */
1279f1974846Sdrh   TriggerStack *trigStack;  /* Trigger actions being coded */
1280f1974846Sdrh   const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
128175897234Sdrh };
128275897234Sdrh 
1283d99bc930Sdanielk1977 /*
128485e2096fSdrh ** An instance of the following structure can be declared on a stack and used
128585e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later.
128685e2096fSdrh */
128785e2096fSdrh struct AuthContext {
128885e2096fSdrh   const char *zAuthContext;   /* Put saved Parse.zAuthContext here */
128985e2096fSdrh   Parse *pParse;              /* The Parse structure */
129085e2096fSdrh };
129185e2096fSdrh 
129285e2096fSdrh /*
1293f0863fe5Sdrh ** Bitfield flags for P2 value in OP_Insert and OP_Delete
1294b0c374ffSrdc */
1295b0c374ffSrdc #define OPFLAG_NCHANGE   1    /* Set to update db->nChange */
1296b0c374ffSrdc #define OPFLAG_LASTROWID 2    /* Set to update db->lastRowid */
129794eb6a14Sdanielk1977 #define OPFLAG_ISUPDATE  4    /* This OP_Insert is an sql UPDATE */
1298b0c374ffSrdc 
1299b0c374ffSrdc /*
1300d99bc930Sdanielk1977  * Each trigger present in the database schema is stored as an instance of
1301d99bc930Sdanielk1977  * struct Trigger.
1302d99bc930Sdanielk1977  *
1303d99bc930Sdanielk1977  * Pointers to instances of struct Trigger are stored in two ways.
13049bb575fdSdrh  * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
1305d99bc930Sdanielk1977  *    database). This allows Trigger structures to be retrieved by name.
1306d99bc930Sdanielk1977  * 2. All triggers associated with a single table form a linked list, using the
1307ad3cab52Sdrh  *    pNext member of struct Trigger. A pointer to the first element of the
1308ad3cab52Sdrh  *    linked list is stored as the "pTrigger" member of the associated
1309ad3cab52Sdrh  *    struct Table.
1310d99bc930Sdanielk1977  *
1311ad3cab52Sdrh  * The "step_list" member points to the first element of a linked list
1312ad3cab52Sdrh  * containing the SQL statements specified as the trigger program.
1313d99bc930Sdanielk1977  */
1314d99bc930Sdanielk1977 struct Trigger {
1315d99bc930Sdanielk1977   char *name;             /* The name of the trigger                        */
1316d99bc930Sdanielk1977   char *table;            /* The table or view to which the trigger applies */
1317f0f258b1Sdrh   u8 op;                  /* One of TK_DELETE, TK_UPDATE, TK_INSERT         */
1318dca76841Sdrh   u8 tr_tm;               /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
1319d99bc930Sdanielk1977   Expr *pWhen;            /* The WHEN clause of the expresion (may be NULL) */
1320d99bc930Sdanielk1977   IdList *pColumns;       /* If this is an UPDATE OF <column-list> trigger,
1321d99bc930Sdanielk1977                              the <column-list> is stored here */
1322d99bc930Sdanielk1977   int foreach;            /* One of TK_ROW or TK_STATEMENT */
13234312db55Sdrh   Token nameToken;        /* Token containing zName. Use during parsing only */
1324e501b89aSdanielk1977   Schema *pSchema;        /* Schema containing the trigger */
1325e501b89aSdanielk1977   Schema *pTabSchema;     /* Schema containing the table */
1326d99bc930Sdanielk1977   TriggerStep *step_list; /* Link list of trigger program steps             */
1327d99bc930Sdanielk1977   Trigger *pNext;         /* Next trigger associated with the table */
1328c3f9bad2Sdanielk1977 };
1329d99bc930Sdanielk1977 
1330d99bc930Sdanielk1977 /*
1331dca76841Sdrh ** A trigger is either a BEFORE or an AFTER trigger.  The following constants
1332dca76841Sdrh ** determine which.
1333dca76841Sdrh **
1334dca76841Sdrh ** If there are multiple triggers, you might of some BEFORE and some AFTER.
1335dca76841Sdrh ** In that cases, the constants below can be ORed together.
1336dca76841Sdrh */
1337dca76841Sdrh #define TRIGGER_BEFORE  1
1338dca76841Sdrh #define TRIGGER_AFTER   2
1339dca76841Sdrh 
1340dca76841Sdrh /*
1341d99bc930Sdanielk1977  * An instance of struct TriggerStep is used to store a single SQL statement
1342d99bc930Sdanielk1977  * that is a part of a trigger-program.
1343d99bc930Sdanielk1977  *
1344d99bc930Sdanielk1977  * Instances of struct TriggerStep are stored in a singly linked list (linked
1345d99bc930Sdanielk1977  * using the "pNext" member) referenced by the "step_list" member of the
1346d99bc930Sdanielk1977  * associated struct Trigger instance. The first element of the linked list is
1347d99bc930Sdanielk1977  * the first step of the trigger-program.
1348d99bc930Sdanielk1977  *
1349d99bc930Sdanielk1977  * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
1350d99bc930Sdanielk1977  * "SELECT" statement. The meanings of the other members is determined by the
1351d99bc930Sdanielk1977  * value of "op" as follows:
1352d99bc930Sdanielk1977  *
1353d99bc930Sdanielk1977  * (op == TK_INSERT)
1354d99bc930Sdanielk1977  * orconf    -> stores the ON CONFLICT algorithm
1355d99bc930Sdanielk1977  * pSelect   -> If this is an INSERT INTO ... SELECT ... statement, then
1356d99bc930Sdanielk1977  *              this stores a pointer to the SELECT statement. Otherwise NULL.
1357d99bc930Sdanielk1977  * target    -> A token holding the name of the table to insert into.
1358d99bc930Sdanielk1977  * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
1359d99bc930Sdanielk1977  *              this stores values to be inserted. Otherwise NULL.
1360d99bc930Sdanielk1977  * pIdList   -> If this is an INSERT INTO ... (<column-names>) VALUES ...
1361ad3cab52Sdrh  *              statement, then this stores the column-names to be
1362ad3cab52Sdrh  *              inserted into.
1363d99bc930Sdanielk1977  *
1364d99bc930Sdanielk1977  * (op == TK_DELETE)
1365d99bc930Sdanielk1977  * target    -> A token holding the name of the table to delete from.
1366d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the DELETE statement if one is specified.
1367d99bc930Sdanielk1977  *              Otherwise NULL.
1368d99bc930Sdanielk1977  *
1369d99bc930Sdanielk1977  * (op == TK_UPDATE)
1370d99bc930Sdanielk1977  * target    -> A token holding the name of the table to update rows of.
1371d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the UPDATE statement if one is specified.
1372d99bc930Sdanielk1977  *              Otherwise NULL.
1373d99bc930Sdanielk1977  * pExprList -> A list of the columns to update and the expressions to update
13744adee20fSdanielk1977  *              them to. See sqlite3Update() documentation of "pChanges"
1375ad3cab52Sdrh  *              argument.
1376d99bc930Sdanielk1977  *
1377d99bc930Sdanielk1977  */
1378c3f9bad2Sdanielk1977 struct TriggerStep {
1379c3f9bad2Sdanielk1977   int op;              /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1380d99bc930Sdanielk1977   int orconf;          /* OE_Rollback etc. */
1381a69d9168Sdrh   Trigger *pTrig;      /* The trigger that this step is a part of */
1382c3f9bad2Sdanielk1977 
1383c3f9bad2Sdanielk1977   Select *pSelect;     /* Valid for SELECT and sometimes
1384c3f9bad2Sdanielk1977 			  INSERT steps (when pExprList == 0) */
1385c3f9bad2Sdanielk1977   Token target;        /* Valid for DELETE, UPDATE, INSERT steps */
1386c3f9bad2Sdanielk1977   Expr *pWhere;        /* Valid for DELETE, UPDATE steps */
1387c3f9bad2Sdanielk1977   ExprList *pExprList; /* Valid for UPDATE statements and sometimes
1388c3f9bad2Sdanielk1977 			   INSERT steps (when pSelect == 0)         */
1389c3f9bad2Sdanielk1977   IdList *pIdList;     /* Valid for INSERT statements only */
1390c3f9bad2Sdanielk1977 
1391c3f9bad2Sdanielk1977   TriggerStep * pNext; /* Next in the link-list */
1392c3f9bad2Sdanielk1977 };
1393c3f9bad2Sdanielk1977 
1394d99bc930Sdanielk1977 /*
1395d99bc930Sdanielk1977  * An instance of struct TriggerStack stores information required during code
1396d99bc930Sdanielk1977  * generation of a single trigger program. While the trigger program is being
1397d99bc930Sdanielk1977  * coded, its associated TriggerStack instance is pointed to by the
1398d99bc930Sdanielk1977  * "pTriggerStack" member of the Parse structure.
1399d99bc930Sdanielk1977  *
1400d99bc930Sdanielk1977  * The pTab member points to the table that triggers are being coded on. The
1401d99bc930Sdanielk1977  * newIdx member contains the index of the vdbe cursor that points at the temp
1402d99bc930Sdanielk1977  * table that stores the new.* references. If new.* references are not valid
1403d99bc930Sdanielk1977  * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1404d99bc930Sdanielk1977  * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1405d99bc930Sdanielk1977  *
1406d99bc930Sdanielk1977  * The ON CONFLICT policy to be used for the trigger program steps is stored
1407d99bc930Sdanielk1977  * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1408d99bc930Sdanielk1977  * specified for individual triggers steps is used.
1409d99bc930Sdanielk1977  *
1410d99bc930Sdanielk1977  * struct TriggerStack has a "pNext" member, to allow linked lists to be
1411d99bc930Sdanielk1977  * constructed. When coding nested triggers (triggers fired by other triggers)
1412d99bc930Sdanielk1977  * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1413d99bc930Sdanielk1977  * pointer. Once the nested trigger has been coded, the pNext value is restored
1414d99bc930Sdanielk1977  * to the pTriggerStack member of the Parse stucture and coding of the parent
1415d99bc930Sdanielk1977  * trigger continues.
1416d99bc930Sdanielk1977  *
1417d99bc930Sdanielk1977  * Before a nested trigger is coded, the linked list pointed to by the
1418d99bc930Sdanielk1977  * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1419d99bc930Sdanielk1977  * recursively. If this condition is detected, the nested trigger is not coded.
1420d99bc930Sdanielk1977  */
1421d99bc930Sdanielk1977 struct TriggerStack {
1422d99bc930Sdanielk1977   Table *pTab;         /* Table that triggers are currently being coded on */
1423d99bc930Sdanielk1977   int newIdx;          /* Index of vdbe cursor to "new" temp table */
1424d99bc930Sdanielk1977   int oldIdx;          /* Index of vdbe cursor to "old" temp table */
1425d99bc930Sdanielk1977   int orconf;          /* Current orconf policy */
14266f34903eSdanielk1977   int ignoreJump;      /* where to jump to for a RAISE(IGNORE) */
1427e22a334bSdrh   Trigger *pTrigger;   /* The trigger currently being coded */
1428e22a334bSdrh   TriggerStack *pNext; /* Next trigger down on the trigger stack */
1429c3f9bad2Sdanielk1977 };
1430c3f9bad2Sdanielk1977 
1431d99bc930Sdanielk1977 /*
1432f26e09c8Sdrh ** The following structure contains information used by the sqliteFix...
1433f26e09c8Sdrh ** routines as they walk the parse tree to make database references
1434f26e09c8Sdrh ** explicit.
1435f26e09c8Sdrh */
1436f26e09c8Sdrh typedef struct DbFixer DbFixer;
1437f26e09c8Sdrh struct DbFixer {
1438f26e09c8Sdrh   Parse *pParse;      /* The parsing context.  Error messages written here */
1439f26e09c8Sdrh   const char *zDb;    /* Make sure all objects are contained in this database */
1440f26e09c8Sdrh   const char *zType;  /* Type of the container - used for error messages */
1441f26e09c8Sdrh   const Token *pName; /* Name of the container - used for error messages */
1442f26e09c8Sdrh };
1443f26e09c8Sdrh 
1444f26e09c8Sdrh /*
1445234c39dfSdrh ** A pointer to this structure is used to communicate information
1446234c39dfSdrh ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
1447234c39dfSdrh */
1448234c39dfSdrh typedef struct {
14499bb575fdSdrh   sqlite3 *db;        /* The database being initialized */
1450234c39dfSdrh   char **pzErrMsg;    /* Error message stored here */
1451234c39dfSdrh } InitData;
1452234c39dfSdrh 
1453b6c29897Sdrh /*
1454d99bc930Sdanielk1977  * This global flag is set for performance testing of triggers. When it is set
1455d99bc930Sdanielk1977  * SQLite will perform the overhead of building new and old trigger references
1456d99bc930Sdanielk1977  * even when no triggers exist
1457d99bc930Sdanielk1977  */
145838f8271fSdrh extern int sqlite3_always_code_trigger_setup;
1459c3f9bad2Sdanielk1977 
146075897234Sdrh /*
146149285708Sdrh ** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production
146249285708Sdrh ** builds) or a function call (for debugging).  If it is a function call,
146349285708Sdrh ** it allows the operator to set a breakpoint at the spot where database
146449285708Sdrh ** corruption is first detected.
146549285708Sdrh */
146649285708Sdrh #ifdef SQLITE_DEBUG
146749285708Sdrh   extern int sqlite3Corrupt(void);
146849285708Sdrh # define SQLITE_CORRUPT_BKPT sqlite3Corrupt()
146949285708Sdrh #else
147049285708Sdrh # define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT
147149285708Sdrh #endif
147249285708Sdrh 
147349285708Sdrh /*
147475897234Sdrh ** Internal function prototypes
147575897234Sdrh */
14764adee20fSdanielk1977 int sqlite3StrICmp(const char *, const char *);
14774adee20fSdanielk1977 int sqlite3StrNICmp(const char *, const char *, int);
14784adee20fSdanielk1977 int sqlite3HashNoCase(const char *, int);
14798a6b5411Sdanielk1977 int sqlite3IsNumber(const char*, int*, u8);
14804adee20fSdanielk1977 int sqlite3Compare(const char *, const char *);
14814adee20fSdanielk1977 int sqlite3SortCompare(const char *, const char *);
14824adee20fSdanielk1977 void sqlite3RealToSortable(double r, char *);
14832e588c75Sdanielk1977 
1484bdb4383aSdrh void *sqlite3Malloc(int);
1485bdb4383aSdrh void *sqlite3MallocRaw(int);
1486bdb4383aSdrh void sqlite3Free(void*);
1487bdb4383aSdrh void *sqlite3Realloc(void*,int);
1488bdb4383aSdrh char *sqlite3StrDup(const char*);
1489bdb4383aSdrh char *sqlite3StrNDup(const char*, int);
14904adee20fSdanielk1977 # define sqlite3CheckMemory(a,b)
149153f733c7Sdrh void sqlite3ReallocOrFree(void**,int);
1492998da3a2Sdrh void sqlite3FreeX(void*);
1493132d8d6aSdrh void *sqlite3MallocX(int);
149413f7299bSdanielk1977 int sqlite3AllocSize(void *);
14952e588c75Sdanielk1977 
14964adee20fSdanielk1977 char *sqlite3MPrintf(const char*, ...);
14974adee20fSdanielk1977 char *sqlite3VMPrintf(const char*, va_list);
1498e54ca3feSdrh void sqlite3DebugPrintf(const char*, ...);
1499fe63d1c9Sdrh void *sqlite3TextToPtr(const char*);
150041f5852eSdrh void sqlite3SetString(char **, ...);
15014adee20fSdanielk1977 void sqlite3ErrorMsg(Parse*, const char*, ...);
1502a073384fSdrh void sqlite3ErrorClear(Parse*);
15034adee20fSdanielk1977 void sqlite3Dequote(char*);
1504d2687b77Sdrh void sqlite3DequoteExpr(Expr*);
15052646da7eSdrh int sqlite3KeywordCode(const unsigned char*, int);
15064adee20fSdanielk1977 int sqlite3RunParser(Parse*, const char*, char **);
150780242055Sdrh void sqlite3FinishCoding(Parse*);
1508e4e72072Sdrh Expr *sqlite3Expr(int, Expr*, Expr*, const Token*);
15094e0cff60Sdrh Expr *sqlite3RegisterExpr(Parse*,Token*);
151091bb0eedSdrh Expr *sqlite3ExprAnd(Expr*, Expr*);
15114adee20fSdanielk1977 void sqlite3ExprSpan(Expr*,Token*,Token*);
15124adee20fSdanielk1977 Expr *sqlite3ExprFunction(ExprList*, Token*);
1513fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse*, Expr*);
15144adee20fSdanielk1977 void sqlite3ExprDelete(Expr*);
15154adee20fSdanielk1977 ExprList *sqlite3ExprListAppend(ExprList*,Expr*,Token*);
15164adee20fSdanielk1977 void sqlite3ExprListDelete(ExprList*);
15179bb575fdSdrh int sqlite3Init(sqlite3*, char**);
1518234c39dfSdrh int sqlite3InitCallback(void*, int, char**, char**);
151991cf71b0Sdanielk1977 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
15209bb575fdSdrh void sqlite3ResetInternalSchema(sqlite3*, int);
15214adee20fSdanielk1977 void sqlite3BeginParse(Parse*,int);
15229bb575fdSdrh void sqlite3RollbackInternalChanges(sqlite3*);
15239bb575fdSdrh void sqlite3CommitInternalChanges(sqlite3*);
15244adee20fSdanielk1977 Table *sqlite3ResultSetOfSelect(Parse*,char*,Select*);
1525c00da105Sdanielk1977 void sqlite3OpenMasterTable(Parse *, int);
1526faa59554Sdrh void sqlite3StartTable(Parse*,Token*,Token*,Token*,int,int,int);
15274adee20fSdanielk1977 void sqlite3AddColumn(Parse*,Token*);
15284adee20fSdanielk1977 void sqlite3AddNotNull(Parse*, int);
1529fdd6e85aSdrh void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
1530ffe07b2dSdrh void sqlite3AddCheckConstraint(Parse*, Expr*);
1531487e262fSdrh void sqlite3AddColumnType(Parse*,Token*);
15327977a17fSdanielk1977 void sqlite3AddDefaultValue(Parse*,Expr*);
1533d3d39e93Sdrh void sqlite3AddCollateType(Parse*, const char*, int);
153419a8e7e8Sdanielk1977 void sqlite3EndTable(Parse*,Token*,Token*,Select*);
1535b7f9164eSdrh 
1536b7f9164eSdrh #ifndef SQLITE_OMIT_VIEW
153748dec7e2Sdanielk1977   void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int);
15384adee20fSdanielk1977   int sqlite3ViewGetColumnNames(Parse*,Table*);
1539b7f9164eSdrh #else
1540b7f9164eSdrh # define sqlite3ViewGetColumnNames(A,B) 0
1541b7f9164eSdrh #endif
1542b7f9164eSdrh 
1543a073384fSdrh void sqlite3DropTable(Parse*, SrcList*, int, int);
15449bb575fdSdrh void sqlite3DeleteTable(sqlite3*, Table*);
15454adee20fSdanielk1977 void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
154613449892Sdrh int sqlite3ArrayAllocate(void**,int,int);
15474adee20fSdanielk1977 IdList *sqlite3IdListAppend(IdList*, Token*);
15484adee20fSdanielk1977 int sqlite3IdListIndex(IdList*,const char*);
15494adee20fSdanielk1977 SrcList *sqlite3SrcListAppend(SrcList*, Token*, Token*);
15504adee20fSdanielk1977 void sqlite3SrcListAddAlias(SrcList*, Token*);
15514adee20fSdanielk1977 void sqlite3SrcListAssignCursors(Parse*, SrcList*);
15524adee20fSdanielk1977 void sqlite3IdListDelete(IdList*);
15534adee20fSdanielk1977 void sqlite3SrcListDelete(SrcList*);
15540202b29eSdanielk1977 void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
15554d91a701Sdrh                         Token*, int, int);
15564d91a701Sdrh void sqlite3DropIndex(Parse*, SrcList*, int);
15574adee20fSdanielk1977 void sqlite3AddKeyType(Vdbe*, ExprList*);
15584adee20fSdanielk1977 void sqlite3AddIdxKeyType(Vdbe*, Index*);
1559b3bce662Sdanielk1977 int sqlite3Select(Parse*, Select*, int, int, Select*, int, int*, char *aff);
15604adee20fSdanielk1977 Select *sqlite3SelectNew(ExprList*,SrcList*,Expr*,ExprList*,Expr*,ExprList*,
1561a2dc3b1aSdanielk1977                         int,Expr*,Expr*);
15624adee20fSdanielk1977 void sqlite3SelectDelete(Select*);
15634adee20fSdanielk1977 void sqlite3SelectUnbind(Select*);
15644adee20fSdanielk1977 Table *sqlite3SrcListLookup(Parse*, SrcList*);
15654adee20fSdanielk1977 int sqlite3IsReadOnly(Parse*, Table*, int);
1566c00da105Sdanielk1977 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
15674adee20fSdanielk1977 void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
15684adee20fSdanielk1977 void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
1569f8db1bc0Sdrh WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**);
15704adee20fSdanielk1977 void sqlite3WhereEnd(WhereInfo*);
15714adee20fSdanielk1977 void sqlite3ExprCode(Parse*, Expr*);
157225303780Sdrh void sqlite3ExprCodeAndCache(Parse*, Expr*);
1573f9b596ebSdrh int sqlite3ExprCodeExprList(Parse*, ExprList*);
15744adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
15754adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
1576205f48e6Sdrh void sqlite3NextedParse(Parse*, const char*, ...);
15779bb575fdSdrh Table *sqlite3FindTable(sqlite3*,const char*, const char*);
15784adee20fSdanielk1977 Table *sqlite3LocateTable(Parse*,const char*, const char*);
15799bb575fdSdrh Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
15809bb575fdSdrh void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
15819bb575fdSdrh void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
15824adee20fSdanielk1977 void sqlite3Vacuum(Parse*, Token*);
15839bb575fdSdrh int sqlite3RunVacuum(char**, sqlite3*);
1584a99db3b6Sdrh char *sqlite3NameFromToken(Token*);
15854adee20fSdanielk1977 int sqlite3ExprCheck(Parse*, Expr*, int, int*);
15864adee20fSdanielk1977 int sqlite3ExprCompare(Expr*, Expr*);
1587cce7d176Sdrh int sqliteFuncId(Token*);
1588b3bce662Sdanielk1977 int sqlite3ExprResolveNames(NameContext *, Expr *);
1589a58fdfb1Sdanielk1977 int sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
15905d9a4af9Sdrh int sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
15914adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse*);
15924adee20fSdanielk1977 void sqlite3Randomness(int, void*);
15939bb575fdSdrh void sqlite3RollbackAll(sqlite3*);
15944adee20fSdanielk1977 void sqlite3CodeVerifySchema(Parse*, int);
1595684917c2Sdrh void sqlite3BeginTransaction(Parse*, int);
15964adee20fSdanielk1977 void sqlite3CommitTransaction(Parse*);
15974adee20fSdanielk1977 void sqlite3RollbackTransaction(Parse*);
15984adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr*);
1599eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr*);
16004adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr*, int*);
16014adee20fSdanielk1977 int sqlite3IsRowid(const char*);
16029bb575fdSdrh void sqlite3GenerateRowDelete(sqlite3*, Vdbe*, Table*, int, int);
16039bb575fdSdrh void sqlite3GenerateRowIndexDelete(sqlite3*, Vdbe*, Table*, int, char*);
160451846b56Sdrh void sqlite3GenerateIndexKey(Vdbe*, Index*, int);
16054adee20fSdanielk1977 void sqlite3GenerateConstraintChecks(Parse*,Table*,int,char*,int,int,int,int);
16064adee20fSdanielk1977 void sqlite3CompleteInsertion(Parse*, Table*, int, char*, int, int, int);
1607290c1948Sdrh void sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
16084adee20fSdanielk1977 void sqlite3BeginWriteOperation(Parse*, int, int);
16094adee20fSdanielk1977 Expr *sqlite3ExprDup(Expr*);
16104adee20fSdanielk1977 void sqlite3TokenCopy(Token*, Token*);
16114adee20fSdanielk1977 ExprList *sqlite3ExprListDup(ExprList*);
16124adee20fSdanielk1977 SrcList *sqlite3SrcListDup(SrcList*);
16134adee20fSdanielk1977 IdList *sqlite3IdListDup(IdList*);
16144adee20fSdanielk1977 Select *sqlite3SelectDup(Select*);
16159bb575fdSdrh FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
16169bb575fdSdrh void sqlite3RegisterBuiltinFunctions(sqlite3*);
16179bb575fdSdrh void sqlite3RegisterDateTimeFunctions(sqlite3*);
16189bb575fdSdrh int sqlite3SafetyOn(sqlite3*);
16199bb575fdSdrh int sqlite3SafetyOff(sqlite3*);
16209bb575fdSdrh int sqlite3SafetyCheck(sqlite3*);
16219bb575fdSdrh void sqlite3ChangeCookie(sqlite3*, Vdbe*, int);
1622b7f9164eSdrh 
1623b7f9164eSdrh #ifndef SQLITE_OMIT_TRIGGER
1624ef2cb63eSdanielk1977   void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
1625ef2cb63eSdanielk1977                            int,Expr*,int);
16264adee20fSdanielk1977   void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
16274adee20fSdanielk1977   void sqlite3DropTrigger(Parse*, SrcList*);
16284adee20fSdanielk1977   void sqlite3DropTriggerPtr(Parse*, Trigger*, int);
1629dca76841Sdrh   int sqlite3TriggersExist(Parse*, Table*, int, ExprList*);
16304adee20fSdanielk1977   int sqlite3CodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
16316f34903eSdanielk1977                            int, int);
1632dc379456Sdrh   void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
16334adee20fSdanielk1977   void sqlite3DeleteTriggerStep(TriggerStep*);
16344adee20fSdanielk1977   TriggerStep *sqlite3TriggerSelectStep(Select*);
16354adee20fSdanielk1977   TriggerStep *sqlite3TriggerInsertStep(Token*, IdList*, ExprList*,Select*,int);
16364adee20fSdanielk1977   TriggerStep *sqlite3TriggerUpdateStep(Token*, ExprList*, Expr*, int);
16374adee20fSdanielk1977   TriggerStep *sqlite3TriggerDeleteStep(Token*, Expr*);
16384adee20fSdanielk1977   void sqlite3DeleteTrigger(Trigger*);
1639b7f9164eSdrh   void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
1640b7f9164eSdrh #else
1641b7f9164eSdrh # define sqlite3TriggersExist(A,B,C,D,E,F) 0
1642b7f9164eSdrh # define sqlite3DeleteTrigger(A)
1643b7f9164eSdrh # define sqlite3DropTriggerPtr(A,B,C)
1644b7f9164eSdrh # define sqlite3UnlinkAndDeleteTrigger(A,B,C)
1645b7f9164eSdrh # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I) 0
1646b7f9164eSdrh #endif
1647b7f9164eSdrh 
16484adee20fSdanielk1977 int sqlite3JoinType(Parse*, Token*, Token*, Token*);
16490202b29eSdanielk1977 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
16504adee20fSdanielk1977 void sqlite3DeferForeignKey(Parse*, int);
1651ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
16524adee20fSdanielk1977   void sqlite3AuthRead(Parse*,Expr*,SrcList*);
16534adee20fSdanielk1977   int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
16544adee20fSdanielk1977   void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
16554adee20fSdanielk1977   void sqlite3AuthContextPop(AuthContext*);
1656ed6c8671Sdrh #else
16574adee20fSdanielk1977 # define sqlite3AuthRead(a,b,c)
16584adee20fSdanielk1977 # define sqlite3AuthCheck(a,b,c,d,e)    SQLITE_OK
16594adee20fSdanielk1977 # define sqlite3AuthContextPush(a,b,c)
16604adee20fSdanielk1977 # define sqlite3AuthContextPop(a)  ((void)(a))
1661ed6c8671Sdrh #endif
1662f744bb56Sdanielk1977 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
1663f744bb56Sdanielk1977 void sqlite3Detach(Parse*, Expr*);
16649bb575fdSdrh int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
166590f5ecb3Sdrh                        int omitJournal, int nCache, Btree **ppBtree);
16664adee20fSdanielk1977 int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
16674adee20fSdanielk1977 int sqlite3FixSrcList(DbFixer*, SrcList*);
16684adee20fSdanielk1977 int sqlite3FixSelect(DbFixer*, Select*);
16694adee20fSdanielk1977 int sqlite3FixExpr(DbFixer*, Expr*);
16704adee20fSdanielk1977 int sqlite3FixExprList(DbFixer*, ExprList*);
16714adee20fSdanielk1977 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
1672487e262fSdrh int sqlite3AtoF(const char *z, double*);
16736f8a503dSdanielk1977 char *sqlite3_snprintf(int,char*,const char*,...);
1674fec19aadSdrh int sqlite3GetInt32(const char *, int*);
1675fec19aadSdrh int sqlite3FitsIn64Bits(const char *);
16766622cce3Sdanielk1977 int sqlite3utf16ByteLen(const void *pData, int nChar);
16776622cce3Sdanielk1977 int sqlite3utf8CharLen(const char *pData, int nByte);
16784e5ffc5fSdrh int sqlite3ReadUtf8(const unsigned char *);
1679192ac1dcSdanielk1977 int sqlite3PutVarint(unsigned char *, u64);
168090e4d95dSdanielk1977 int sqlite3GetVarint(const unsigned char *, u64 *);
16816d2fb154Sdrh int sqlite3GetVarint32(const unsigned char *, u32 *);
1682192ac1dcSdanielk1977 int sqlite3VarintLen(u64 v);
1683a37cdde0Sdanielk1977 void sqlite3IndexAffinityStr(Vdbe *, Index *);
1684a37cdde0Sdanielk1977 void sqlite3TableAffinityStr(Vdbe *, Table *);
1685e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2);
1686e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
1687bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr);
1688eb2e176aSdrh int sqlite3atoi64(const char*, i64*);
16899bb575fdSdrh void sqlite3Error(sqlite3*, int, const char*,...);
1690cbb18d22Sdanielk1977 void *sqlite3HexToBlob(const char *z);
1691ef2cb63eSdanielk1977 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
1692f20b21c8Sdanielk1977 const char *sqlite3ErrStr(int);
1693d02eb1fdSdanielk1977 int sqlite3ReadUniChar(const char *zStr, int *pOffset, u8 *pEnc, int fold);
16948a41449eSdanielk1977 int sqlite3ReadSchema(Parse *pParse);
16959bb575fdSdrh CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
16960202b29eSdanielk1977 CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
16977cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
16987cedc8d4Sdanielk1977 int sqlite3CheckCollSeq(Parse *, CollSeq *);
16997cedc8d4Sdanielk1977 int sqlite3CheckIndexCollSeq(Parse *, Index *);
1700d8123366Sdanielk1977 int sqlite3CheckObjectName(Parse *, const char *);
1701b28af71aSdanielk1977 void sqlite3VdbeSetChanges(sqlite3 *, int);
1702f4618891Sdanielk1977 void sqlite3utf16Substr(sqlite3_context *,int,sqlite3_value **);
17034e6af134Sdanielk1977 
17044e6af134Sdanielk1977 const void *sqlite3ValueText(sqlite3_value*, u8);
17054e6af134Sdanielk1977 int sqlite3ValueBytes(sqlite3_value*, u8);
1706bfd6cce5Sdanielk1977 void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8, void(*)(void*));
17074e6af134Sdanielk1977 void sqlite3ValueFree(sqlite3_value*);
17084f26bb62Sdrh sqlite3_value *sqlite3ValueNew(void);
1709af9a7c22Sdrh char *sqlite3utf16to8(const void*, int);
1710aee18ef8Sdanielk1977 int sqlite3ValueFromExpr(Expr *, u8, u8, sqlite3_value **);
1711aee18ef8Sdanielk1977 void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
17124e5ffc5fSdrh extern const unsigned char sqlite3UpperToLower[];
1713a0bf2652Sdanielk1977 void sqlite3RootPageMoved(Db*, int, int);
17144343fea2Sdrh void sqlite3Reindex(Parse*, Token*, Token*);
17151f01ec1bSdrh void sqlite3AlterFunctions(sqlite3*);
17169fd2a9a0Sdanielk1977 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
17179fd2a9a0Sdanielk1977 int sqlite3GetToken(const unsigned char *, int *);
17182958a4e6Sdrh void sqlite3NestedParse(Parse*, const char*, ...);
1719d89bd007Sdrh void sqlite3ExpirePreparedStatements(sqlite3*);
1720b3bce662Sdanielk1977 void sqlite3CodeSubselect(Parse *, Expr *);
1721b3bce662Sdanielk1977 int sqlite3SelectResolve(Parse *, Select *, NameContext *);
1722aee18ef8Sdanielk1977 void sqlite3ColumnDefault(Vdbe *, Table *, int);
172319a8e7e8Sdanielk1977 void sqlite3AlterFinishAddColumn(Parse *, Token *);
172419a8e7e8Sdanielk1977 void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
17252e66f0b9Sdrh const char *sqlite3TestErrorName(int);
17264dade037Sdanielk1977 CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int);
17278a51256cSdrh char sqlite3AffinityType(const Token*);
17289f18e8a0Sdrh void sqlite3Analyze(Parse*, Token*, Token*);
1729a4afb65cSdrh int sqlite3InvokeBusyHandler(BusyHandler*);
1730ff2d5ea4Sdrh int sqlite3FindDb(sqlite3*, Token*);
1731497e446dSdrh void sqlite3AnalysisLoad(sqlite3*,int iDB);
173251147baaSdrh void sqlite3DefaultRowEst(Index*);
173355ef4d97Sdrh void sqlite3RegisterLikeFunctions(sqlite3*, int);
1734d64fe2f3Sdrh int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
17356f7adc8aSdrh ThreadData *sqlite3ThreadData(void);
17366f7adc8aSdrh const ThreadData *sqlite3ThreadDataReadOnly(void);
17376f7adc8aSdrh void sqlite3ReleaseThreadData(void);
1738f744bb56Sdanielk1977 void sqlite3AttachFunctions(sqlite3 *);
1739fdd6e85aSdrh void sqlite3MinimumFileFormat(Parse*, int, int);
1740da184236Sdanielk1977 void sqlite3SchemaFree(void *);
1741e501b89aSdanielk1977 Schema *sqlite3SchemaGet(Btree *);
1742e501b89aSdanielk1977 int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
1743b3bf556eSdanielk1977 KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *);
1744771151b6Sdanielk1977 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
1745771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **),
1746771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*));
174754f0198eSdanielk1977 int sqlite3ApiExit(sqlite3 *db, int);
1748d1167393Sdrh int sqlite3MallocFailed(void);
1749d1167393Sdrh void sqlite3FailedMalloc(void);
1750*8d34dfd6Sdanielk1977 void sqlite3AbortOtherActiveVdbes(sqlite3 *, Vdbe *);
1751e3026636Sdanielk1977 
1752c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
1753c00da105Sdanielk1977   void sqlite3TableLock(Parse *, int, int, u8, const char *);
1754c00da105Sdanielk1977 #else
1755c00da105Sdanielk1977   #define sqlite3TableLock(v,w,x,y,z)
1756c00da105Sdanielk1977 #endif
1757c00da105Sdanielk1977 
175808659feeSdanielk1977 #ifdef SQLITE_MEMDEBUG
1759d1167393Sdrh   void sqlite3MallocDisallow(void);
1760d1167393Sdrh   void sqlite3MallocAllow(void);
1761d1167393Sdrh   int sqlite3TestMallocFail(void);
176208659feeSdanielk1977 #else
1763c93cc42dSdrh   #define sqlite3TestMallocFail() 0
1764c93cc42dSdrh   #define sqlite3MallocDisallow()
1765c93cc42dSdrh   #define sqlite3MallocAllow()
17662e588c75Sdanielk1977 #endif
17672e588c75Sdanielk1977 
1768fd9a0a45Sdanielk1977 #ifdef SQLITE_SSE
1769fd9a0a45Sdanielk1977 #include "sseInt.h"
1770fd9a0a45Sdanielk1977 #endif
1771fd9a0a45Sdanielk1977 
1772e3026636Sdanielk1977 #endif
1773