blob: c5917c643be935509601ac71ecbaf785ac3d72d1 [file] [log] [blame]
drh75897232000-05-29 14:26:00 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drh75897232000-05-29 14:26:00 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drh75897232000-05-29 14:26:00 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
drh75897232000-05-29 14:26:00 +000010**
11*************************************************************************
12** Internal interface definitions for SQLite.
13**
drha3152892007-05-05 11:48:52 +000014** @(#) $Id: sqliteInt.h,v 1.557 2007/05/05 11:48:54 drh Exp $
drh75897232000-05-29 14:26:00 +000015*/
danielk1977e3026632004-06-22 11:29:02 +000016#ifndef _SQLITEINT_H_
17#define _SQLITEINT_H_
18
drh4f0c5872007-03-26 22:05:01 +000019#if defined(SQLITE_TCL) || defined(TCLSH)
20# include <tcl.h>
drh824d7c12006-01-06 12:03:19 +000021#endif
22
23/*
drh4b529d92005-09-13 00:00:00 +000024** Many people are failing to set -DNDEBUG=1 when compiling SQLite.
drhb27795c2005-09-13 00:02:16 +000025** Setting NDEBUG makes the code smaller and run faster. So the following
drh4b529d92005-09-13 00:00:00 +000026** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1
27** option is set. Thus NDEBUG becomes an opt-in rather than an opt-out
28** feature.
29*/
danielk1977771151b2006-01-17 13:21:40 +000030#if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
drh4b529d92005-09-13 00:00:00 +000031# define NDEBUG 1
32#endif
33
34/*
drheb206252004-10-01 02:00:31 +000035** These #defines should enable >2GB file support on Posix if the
36** underlying operating system supports it. If the OS lacks
37** large file support, or if the OS is windows, these should be no-ops.
38**
39** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
40** on the compiler command line. This is necessary if you are compiling
41** on a recent machine (ex: RedHat 7.2) but you want your code to work
42** on an older machine (ex: RedHat 6.0). If you compile on RedHat 7.2
43** without this option, LFS is enable. But LFS does not exist in the kernel
44** in RedHat 6.0, so the code won't work. Hence, for maximum binary
45** portability you should omit LFS.
46**
47** Similar is true for MacOS. LFS is only supported on MacOS 9 and later.
48*/
49#ifndef SQLITE_DISABLE_LFS
50# define _LARGE_FILE 1
51# ifndef _FILE_OFFSET_BITS
52# define _FILE_OFFSET_BITS 64
53# endif
54# define _LARGEFILE_SOURCE 1
55#endif
56
drh1d482dd2004-05-31 18:23:07 +000057#include "sqlite3.h"
drhbeae3192001-09-22 18:12:08 +000058#include "hash.h"
drh75897232000-05-29 14:26:00 +000059#include "parse.h"
drh75897232000-05-29 14:26:00 +000060#include <stdio.h>
61#include <stdlib.h>
62#include <string.h>
63#include <assert.h>
drh52370e22005-01-21 21:31:40 +000064#include <stddef.h>
drh75897232000-05-29 14:26:00 +000065
drh967e8b72000-06-21 13:59:10 +000066/*
drhb37df7b2005-10-13 02:09:49 +000067** If compiling for a processor that lacks floating point support,
68** substitute integer for floating-point
69*/
70#ifdef SQLITE_OMIT_FLOATING_POINT
71# define double sqlite_int64
72# define LONGDOUBLE_TYPE sqlite_int64
drhd1167392006-01-23 13:00:35 +000073# ifndef SQLITE_BIG_DBL
74# define SQLITE_BIG_DBL (0x7fffffffffffffff)
75# endif
drhb37df7b2005-10-13 02:09:49 +000076# define SQLITE_OMIT_DATETIME_FUNCS 1
77# define SQLITE_OMIT_TRACE 1
drh110daac2007-05-04 11:59:31 +000078# undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
drhb37df7b2005-10-13 02:09:49 +000079#endif
drhd1167392006-01-23 13:00:35 +000080#ifndef SQLITE_BIG_DBL
81# define SQLITE_BIG_DBL (1e99)
82#endif
drhb37df7b2005-10-13 02:09:49 +000083
84/*
drha1b351a2001-09-14 16:42:12 +000085** The maximum number of in-memory pages to use for the main database
danielk197724c8ab82005-02-09 01:40:23 +000086** table and for temporary tables. Internally, the MAX_PAGES and
87** TEMP_PAGES macros are used. To override the default values at
88** compilation time, the SQLITE_DEFAULT_CACHE_SIZE and
89** SQLITE_DEFAULT_TEMP_CACHE_SIZE macros should be set.
drha1b351a2001-09-14 16:42:12 +000090*/
drh1ba1e6e2005-01-21 21:22:52 +000091#ifdef SQLITE_DEFAULT_CACHE_SIZE
92# define MAX_PAGES SQLITE_DEFAULT_CACHE_SIZE
93#else
94# define MAX_PAGES 2000
95#endif
danielk197724c8ab82005-02-09 01:40:23 +000096#ifdef SQLITE_DEFAULT_TEMP_CACHE_SIZE
97# define TEMP_PAGES SQLITE_DEFAULT_TEMP_CACHE_SIZE
98#else
99# define TEMP_PAGES 500
100#endif
drha1b351a2001-09-14 16:42:12 +0000101
102/*
danielk197753c0f742005-03-29 03:10:59 +0000103** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
104** afterward. Having this macro allows us to cause the C compiler
105** to omit code used by TEMP tables without messy #ifndef statements.
106*/
107#ifdef SQLITE_OMIT_TEMPDB
108#define OMIT_TEMPDB 1
109#else
110#define OMIT_TEMPDB 0
111#endif
112
113/*
drh0bd1f4e2002-06-06 18:54:39 +0000114** If the following macro is set to 1, then NULL values are considered
drh0bd1f4e2002-06-06 18:54:39 +0000115** distinct when determining whether or not two entries are the same
116** in a UNIQUE index. This is the way PostgreSQL, Oracle, DB2, MySQL,
117** OCELOT, and Firebird all work. The SQL92 spec explicitly says this
118** is the way things are suppose to work.
119**
120** If the following macro is set to 0, the NULLs are indistinct for
121** a UNIQUE index. In this mode, you can only have a single NULL entry
122** for a column declared UNIQUE. This is the way Informix and SQL Server
123** work.
124*/
125#define NULL_DISTINCT_FOR_UNIQUE 1
126
127/*
drh665de472003-03-31 13:36:09 +0000128** The maximum number of attached databases. This must be at least 2
129** in order to support the main database file (0) and the file used to
drh80242052004-06-09 00:48:12 +0000130** hold temporary tables (1). And it must be less than 32 because
131** we use a bitmask of databases with a u32 in places (for example
132** the Parse.cookieMask field).
drh665de472003-03-31 13:36:09 +0000133*/
134#define MAX_ATTACHED 10
135
136/*
drhfa6bc002004-09-07 16:19:52 +0000137** The maximum value of a ?nnn wildcard that the parser will accept.
138*/
139#define SQLITE_MAX_VARIABLE_NUMBER 999
140
141/*
drhd946db02005-12-29 19:23:06 +0000142** The "file format" number is an integer that is incremented whenever
143** the VDBE-level file format changes. The following macros define the
144** the default file format for new databases and the maximum file format
145** that the library can read.
146*/
147#define SQLITE_MAX_FILE_FORMAT 4
148#ifndef SQLITE_DEFAULT_FILE_FORMAT
drh76fe8032006-07-11 14:17:51 +0000149# define SQLITE_DEFAULT_FILE_FORMAT 1
drhd946db02005-12-29 19:23:06 +0000150#endif
151
152/*
drh49766d62005-01-08 18:42:28 +0000153** Provide a default value for TEMP_STORE in case it is not specified
154** on the command-line
155*/
156#ifndef TEMP_STORE
157# define TEMP_STORE 1
158#endif
159
160/*
drhf1974842004-11-05 03:56:00 +0000161** GCC does not define the offsetof() macro so we'll have to do it
162** ourselves.
163*/
164#ifndef offsetof
165#define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
166#endif
167
168/*
drh9b8f4472006-04-04 01:54:55 +0000169** Check to see if this machine uses EBCDIC. (Yes, believe it or
170** not, there are still machines out there that use EBCDIC.)
171*/
172#if 'A' == '\301'
173# define SQLITE_EBCDIC 1
174#else
175# define SQLITE_ASCII 1
176#endif
177
178/*
drh5a2c2c22001-11-21 02:21:11 +0000179** Integers of known sizes. These typedefs might change for architectures
180** where the sizes very. Preprocessor macros are available so that the
181** types can be conveniently redefined at compile-type. Like this:
182**
183** cc '-DUINTPTR_TYPE=long long int' ...
drh41a2b482001-01-20 19:52:49 +0000184*/
drh5a2c2c22001-11-21 02:21:11 +0000185#ifndef UINT32_TYPE
186# define UINT32_TYPE unsigned int
187#endif
188#ifndef UINT16_TYPE
189# define UINT16_TYPE unsigned short int
190#endif
drh939a16d2004-07-15 13:37:22 +0000191#ifndef INT16_TYPE
192# define INT16_TYPE short int
193#endif
drh5a2c2c22001-11-21 02:21:11 +0000194#ifndef UINT8_TYPE
195# define UINT8_TYPE unsigned char
196#endif
drh905793e2004-02-21 13:31:09 +0000197#ifndef INT8_TYPE
198# define INT8_TYPE signed char
199#endif
drhefad9992004-06-22 12:13:55 +0000200#ifndef LONGDOUBLE_TYPE
201# define LONGDOUBLE_TYPE long double
202#endif
drhefad9992004-06-22 12:13:55 +0000203typedef sqlite_int64 i64; /* 8-byte signed integer */
drh27436af2006-03-28 23:57:17 +0000204typedef sqlite_uint64 u64; /* 8-byte unsigned integer */
drh5a2c2c22001-11-21 02:21:11 +0000205typedef UINT32_TYPE u32; /* 4-byte unsigned integer */
206typedef UINT16_TYPE u16; /* 2-byte unsigned integer */
drh939a16d2004-07-15 13:37:22 +0000207typedef INT16_TYPE i16; /* 2-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000208typedef UINT8_TYPE u8; /* 1-byte unsigned integer */
drh905793e2004-02-21 13:31:09 +0000209typedef UINT8_TYPE i8; /* 1-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000210
211/*
drhbbd42a62004-05-22 17:41:58 +0000212** Macros to determine whether the machine is big or little endian,
213** evaluated at runtime.
214*/
215extern const int sqlite3one;
drh38def052007-03-31 15:27:59 +0000216#if defined(i386) || defined(__i386__) || defined(_M_IX86)
217# define SQLITE_BIGENDIAN 0
218# define SQLITE_LITTLEENDIAN 1
219# define SQLITE_UTF16NATIVE SQLITE_UTF16LE
220#else
221# define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0)
222# define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
223# define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
224#endif
drhbbd42a62004-05-22 17:41:58 +0000225
226/*
drh90f5ecb2004-07-22 01:19:35 +0000227** An instance of the following structure is used to store the busy-handler
228** callback for a given sqlite handle.
229**
230** The sqlite.busyHandler member of the sqlite struct contains the busy
231** callback for the database handle. Each pager opened via the sqlite
232** handle is passed a pointer to sqlite.busyHandler. The busy-handler
233** callback is currently invoked only from within pager.c.
234*/
235typedef struct BusyHandler BusyHandler;
236struct BusyHandler {
237 int (*xFunc)(void *,int); /* The busy callback */
238 void *pArg; /* First arg to busy callback */
drha4afb652005-07-09 02:16:02 +0000239 int nBusy; /* Incremented with each busy call */
drh90f5ecb2004-07-22 01:19:35 +0000240};
241
242/*
243** Defer sourcing vdbe.h and btree.h until after the "u8" and
244** "BusyHandler typedefs.
drh905793e2004-02-21 13:31:09 +0000245*/
246#include "vdbe.h"
drh3aac2dd2004-04-26 14:10:20 +0000247#include "btree.h"
danielk197713f72992005-12-18 08:51:22 +0000248#include "pager.h"
drh905793e2004-02-21 13:31:09 +0000249
danielk19772c336542005-01-13 02:14:23 +0000250#ifdef SQLITE_MEMDEBUG
drh75897232000-05-29 14:26:00 +0000251/*
drh6e142f52000-06-08 13:36:40 +0000252** The following global variables are used for testing and debugging
danielk1977c00da102006-01-07 13:21:04 +0000253** only. They only work if SQLITE_MEMDEBUG is defined.
drh6e142f52000-06-08 13:36:40 +0000254*/
drh46934232004-11-20 19:18:00 +0000255extern int sqlite3_nMalloc; /* Number of sqliteMalloc() calls */
256extern int sqlite3_nFree; /* Number of sqliteFree() calls */
257extern int sqlite3_iMallocFail; /* Fail sqliteMalloc() after this many calls */
258extern int sqlite3_iMallocReset; /* Set iMallocFail to this when it reaches 0 */
danielk19779e128002006-01-18 16:51:35 +0000259
danielk19779e128002006-01-18 16:51:35 +0000260extern void *sqlite3_pFirst; /* Pointer to linked list of allocations */
261extern int sqlite3_nMaxAlloc; /* High water mark of ThreadData.nAlloc */
262extern int sqlite3_mallocDisallowed; /* assert() in sqlite3Malloc() if set */
263extern int sqlite3_isFail; /* True if all malloc calls should fail */
264extern const char *sqlite3_zFile; /* Filename to associate debug info with */
265extern int sqlite3_iLine; /* Line number for debug info */
266
267#define ENTER_MALLOC (sqlite3_zFile = __FILE__, sqlite3_iLine = __LINE__)
danielk1977750b03e2006-02-14 10:48:39 +0000268#define sqliteMalloc(x) (ENTER_MALLOC, sqlite3Malloc(x,1))
269#define sqliteMallocRaw(x) (ENTER_MALLOC, sqlite3MallocRaw(x,1))
danielk1977c00da102006-01-07 13:21:04 +0000270#define sqliteRealloc(x,y) (ENTER_MALLOC, sqlite3Realloc(x,y))
271#define sqliteStrDup(x) (ENTER_MALLOC, sqlite3StrDup(x))
272#define sqliteStrNDup(x,y) (ENTER_MALLOC, sqlite3StrNDup(x,y))
273#define sqliteReallocOrFree(x,y) (ENTER_MALLOC, sqlite3ReallocOrFree(x,y))
danielk19772e588c72005-12-09 14:25:08 +0000274
danielk197797cb2e92005-12-09 14:39:04 +0000275#else
276
danielk19778ae59d52006-02-17 15:01:36 +0000277#define ENTER_MALLOC 0
drhe8c15132006-02-15 21:19:01 +0000278#define sqliteMalloc(x) sqlite3Malloc(x,1)
279#define sqliteMallocRaw(x) sqlite3MallocRaw(x,1)
danielk1977c00da102006-01-07 13:21:04 +0000280#define sqliteRealloc(x,y) sqlite3Realloc(x,y)
281#define sqliteStrDup(x) sqlite3StrDup(x)
282#define sqliteStrNDup(x,y) sqlite3StrNDup(x,y)
283#define sqliteReallocOrFree(x,y) sqlite3ReallocOrFree(x,y)
danielk197797cb2e92005-12-09 14:39:04 +0000284
285#endif
286
danielk197713f72992005-12-18 08:51:22 +0000287#define sqliteFree(x) sqlite3FreeX(x)
288#define sqliteAllocSize(x) sqlite3AllocSize(x)
danielk197797cb2e92005-12-09 14:39:04 +0000289
danielk1977e7259292006-01-13 06:33:23 +0000290
danielk19772e588c72005-12-09 14:25:08 +0000291/*
drh6f7adc82006-01-11 21:41:20 +0000292** An instance of this structure might be allocated to store information
293** specific to a single thread.
danielk19772e588c72005-12-09 14:25:08 +0000294*/
danielk1977e501b892006-01-09 06:29:47 +0000295struct ThreadData {
drh6dc1d952006-01-23 00:04:54 +0000296 int dummy; /* So that this structure is never empty */
danielk19775591df52005-12-20 09:19:37 +0000297
drh6f7adc82006-01-11 21:41:20 +0000298#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drhd2d4a6b2006-01-10 15:18:27 +0000299 int nSoftHeapLimit; /* Suggested max mem allocation. No limit if <0 */
300 int nAlloc; /* Number of bytes currently allocated */
danielk19775591df52005-12-20 09:19:37 +0000301 Pager *pPager; /* Linked list of all pagers in this thread */
danielk19777ddad962005-12-12 06:53:03 +0000302#endif
303
danielk1977aef0bf62005-12-30 16:28:01 +0000304#ifndef SQLITE_OMIT_SHARED_CACHE
305 u8 useSharedData; /* True if shared pagers and schemas are enabled */
drhd78901d2006-01-05 23:42:50 +0000306 BtShared *pBtree; /* Linked list of all currently open BTrees */
danielk1977aef0bf62005-12-30 16:28:01 +0000307#endif
danielk19772e588c72005-12-09 14:25:08 +0000308};
309
drh6e142f52000-06-08 13:36:40 +0000310/*
drh75897232000-05-29 14:26:00 +0000311** Name of the master database table. The master database table
312** is a special table that holds the names and attributes of all
313** user tables and indices.
314*/
drhe0bc4042002-06-25 01:09:11 +0000315#define MASTER_NAME "sqlite_master"
316#define TEMP_MASTER_NAME "sqlite_temp_master"
drh75897232000-05-29 14:26:00 +0000317
318/*
danielk19778e150812004-05-10 01:17:37 +0000319** The root-page of the master database table.
320*/
321#define MASTER_ROOT 1
322
323/*
drhed6c8672003-01-12 18:02:16 +0000324** The name of the schema table.
325*/
danielk197753c0f742005-03-29 03:10:59 +0000326#define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
drhed6c8672003-01-12 18:02:16 +0000327
328/*
drh75897232000-05-29 14:26:00 +0000329** A convenience macro that returns the number of elements in
330** an array.
331*/
332#define ArraySize(X) (sizeof(X)/sizeof(X[0]))
333
334/*
335** Forward references to structures
336*/
drh13449892005-09-07 21:22:45 +0000337typedef struct AggInfo AggInfo;
drhfe05af82005-07-21 03:14:59 +0000338typedef struct AuthContext AuthContext;
339typedef struct CollSeq CollSeq;
drh7020f652000-06-03 18:06:52 +0000340typedef struct Column Column;
drhfe05af82005-07-21 03:14:59 +0000341typedef struct Db Db;
danielk1977e501b892006-01-09 06:29:47 +0000342typedef struct Schema Schema;
drh75897232000-05-29 14:26:00 +0000343typedef struct Expr Expr;
344typedef struct ExprList ExprList;
drhc2eef3b2002-08-31 18:53:06 +0000345typedef struct FKey FKey;
drhfe05af82005-07-21 03:14:59 +0000346typedef struct FuncDef FuncDef;
347typedef struct IdList IdList;
348typedef struct Index Index;
danielk19778d059842004-05-12 11:24:02 +0000349typedef struct KeyClass KeyClass;
drhd3d39e92004-05-20 22:16:29 +0000350typedef struct KeyInfo KeyInfo;
danielk1977d1ab1ba2006-06-15 04:28:13 +0000351typedef struct Module Module;
drh626a8792005-01-17 22:08:19 +0000352typedef struct NameContext NameContext;
drhfe05af82005-07-21 03:14:59 +0000353typedef struct Parse Parse;
354typedef struct Select Select;
355typedef struct SrcList SrcList;
danielk1977e501b892006-01-09 06:29:47 +0000356typedef struct ThreadData ThreadData;
drhfe05af82005-07-21 03:14:59 +0000357typedef struct Table Table;
danielk1977c00da102006-01-07 13:21:04 +0000358typedef struct TableLock TableLock;
drhfe05af82005-07-21 03:14:59 +0000359typedef struct Token Token;
360typedef struct TriggerStack TriggerStack;
361typedef struct TriggerStep TriggerStep;
362typedef struct Trigger Trigger;
drhfe05af82005-07-21 03:14:59 +0000363typedef struct WhereInfo WhereInfo;
364typedef struct WhereLevel WhereLevel;
drhd3d39e92004-05-20 22:16:29 +0000365
drh001bbcb2003-03-19 03:14:00 +0000366/*
367** Each database file to be accessed by the system is an instance
368** of the following structure. There are normally two of these structures
369** in the sqlite.aDb[] array. aDb[0] is the main database file and
drha69d9162003-04-17 22:57:53 +0000370** aDb[1] is the database file used to hold temporary tables. Additional
371** databases may be attached.
drh001bbcb2003-03-19 03:14:00 +0000372*/
373struct Db {
374 char *zName; /* Name of this database */
375 Btree *pBt; /* The B*Tree structure for this database file */
danielk1977da184232006-01-05 11:34:32 +0000376 u8 inTrans; /* 0: not writable. 1: Transaction. 2: Checkpoint */
377 u8 safety_level; /* How aggressive at synching data to disk */
danielk1977da184232006-01-05 11:34:32 +0000378 void *pAux; /* Auxiliary data. Usually NULL */
379 void (*xFreeAux)(void*); /* Routine to free pAux */
danielk1977e501b892006-01-09 06:29:47 +0000380 Schema *pSchema; /* Pointer to database schema (possibly shared) */
danielk1977da184232006-01-05 11:34:32 +0000381};
382
383/*
384** An instance of the following structure stores a database schema.
danielk1977a04a34f2007-04-16 15:06:25 +0000385**
386** If there are no virtual tables configured in this schema, the
387** Schema.db variable is set to NULL. After the first virtual table
388** has been added, it is set to point to the database connection
389** used to create the connection. Once a virtual table has been
390** added to the Schema structure and the Schema.db variable populated,
391** only that database connection may use the Schema to prepare
392** statements.
danielk1977da184232006-01-05 11:34:32 +0000393*/
danielk1977e501b892006-01-09 06:29:47 +0000394struct Schema {
drh001bbcb2003-03-19 03:14:00 +0000395 int schema_cookie; /* Database schema version number for this file */
drhd24cc422003-03-27 12:51:24 +0000396 Hash tblHash; /* All tables indexed by name */
397 Hash idxHash; /* All (named) indices indexed by name */
398 Hash trigHash; /* All triggers indexed by name */
399 Hash aFKey; /* Foreign keys indexed by to-table */
drh4794f732004-11-05 17:17:50 +0000400 Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */
danielk1977da184232006-01-05 11:34:32 +0000401 u8 file_format; /* Schema format version for this file */
drh8079a0d2006-01-12 17:20:50 +0000402 u8 enc; /* Text encoding used by this database */
danielk1977da184232006-01-05 11:34:32 +0000403 u16 flags; /* Flags associated with this schema */
danielk197714db2662006-01-09 16:12:04 +0000404 int cache_size; /* Number of pages to use in the cache */
danielk1977a04a34f2007-04-16 15:06:25 +0000405#ifndef SQLITE_OMIT_VIRTUALTABLE
406 sqlite3 *db; /* "Owner" connection. See comment above */
407#endif
drh001bbcb2003-03-19 03:14:00 +0000408};
drh75897232000-05-29 14:26:00 +0000409
410/*
drh8bf8dc92003-05-17 17:35:10 +0000411** These macros can be used to test, set, or clear bits in the
412** Db.flags field.
413*/
danielk1977da184232006-01-05 11:34:32 +0000414#define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))==(P))
415#define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))!=0)
416#define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->flags|=(P)
417#define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->flags&=~(P)
drh8bf8dc92003-05-17 17:35:10 +0000418
419/*
420** Allowed values for the DB.flags field.
421**
drh8bf8dc92003-05-17 17:35:10 +0000422** The DB_SchemaLoaded flag is set after the database schema has been
423** read into internal hash tables.
424**
425** DB_UnresetViews means that one or more views have column names that
426** have been filled out. If the schema changes, these column names might
427** changes and so the view will need to be reset.
428*/
drh124b27e2004-06-19 16:06:10 +0000429#define DB_SchemaLoaded 0x0001 /* The schema has been loaded */
430#define DB_UnresetViews 0x0002 /* Some views have defined column names */
danielk1977b82e7ed2006-01-11 14:09:31 +0000431#define DB_Empty 0x0004 /* The file is empty (length 0 bytes) */
drh8bf8dc92003-05-17 17:35:10 +0000432
433
434/*
drhc9b84a12002-06-20 11:36:48 +0000435** Each database is an instance of the following structure.
436**
rdcb0c374f2004-02-20 22:53:38 +0000437** The sqlite.lastRowid records the last insert rowid generated by an
438** insert statement. Inserts on views do not affect its value. Each
439** trigger has its own context, so that lastRowid can be updated inside
440** triggers as usual. The previous value will be restored once the trigger
441** exits. Upon entering a before or instead of trigger, lastRowid is no
442** longer (since after version 2.8.12) reset to -1.
443**
444** The sqlite.nChange does not count changes within triggers and keeps no
danielk19776f8a5032004-05-10 10:34:51 +0000445** context. It is reset at start of sqlite3_exec.
rdcb0c374f2004-02-20 22:53:38 +0000446** The sqlite.lsChange represents the number of changes made by the last
447** insert, update, or delete statement. It remains constant throughout the
448** length of a statement and is then updated by OP_SetCounts. It keeps a
449** context stack just like lastRowid so that the count of changes
450** within a trigger is not seen outside the trigger. Changes to views do not
451** affect the value of lsChange.
452** The sqlite.csChange keeps track of the number of current changes (since
453** the last statement) and is used to update sqlite_lsChange.
danielk19776622cce2004-05-20 11:00:52 +0000454**
455** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
456** store the most recent error code and, if applicable, string. The
457** internal function sqlite3Error() is used to set these variables
458** consistently.
drh75897232000-05-29 14:26:00 +0000459*/
drh9bb575f2004-09-06 17:24:11 +0000460struct sqlite3 {
drh001bbcb2003-03-19 03:14:00 +0000461 int nDb; /* Number of backends currently in use */
462 Db *aDb; /* All backends */
drh5e00f6c2001-09-13 13:46:56 +0000463 int flags; /* Miscellanous flags. See below */
drhfcd35c72005-05-21 02:48:08 +0000464 int errCode; /* Most recent error code (SQLITE_*) */
drh4ac285a2006-09-15 07:28:50 +0000465 int errMask; /* & result codes with this before returning */
drhfcd35c72005-05-21 02:48:08 +0000466 u8 autoCommit; /* The auto-commit flag. */
drh90f5ecb2004-07-22 01:19:35 +0000467 u8 temp_store; /* 1: file 2: memory 0: default */
drh5e00f6c2001-09-13 13:46:56 +0000468 int nTable; /* Number of tables in the database */
drhd3d39e92004-05-20 22:16:29 +0000469 CollSeq *pDfltColl; /* The default collating sequence (BINARY) */
drhf328bc82004-05-10 23:29:49 +0000470 i64 lastRowid; /* ROWID of most recent insert (see above) */
471 i64 priorNewRowid; /* Last randomly generated ROWID */
drh247be432002-05-10 05:44:55 +0000472 int magic; /* Magic number for detect library misuse */
danielk1977b28af712004-06-21 06:50:26 +0000473 int nChange; /* Value returned by sqlite3_changes() */
474 int nTotalChange; /* Value returned by sqlite3_total_changes() */
475 struct sqlite3InitInfo { /* Information used during initialization */
476 int iDb; /* When back is being initialized */
477 int newTnum; /* Rootpage of table being initialized */
478 u8 busy; /* TRUE if currently initializing */
drh1d85d932004-02-14 23:05:52 +0000479 } init;
drhf1952c52006-06-08 15:48:00 +0000480 int nExtension; /* Number of loaded extensions */
drh761df872006-12-21 01:29:22 +0000481 void **aExtension; /* Array of shared libraray handles */
drh326dce72003-01-29 14:06:07 +0000482 struct Vdbe *pVdbe; /* List of active virtual machines */
danielk19771d850a72004-05-31 08:26:49 +0000483 int activeVdbeCnt; /* Number of vdbes currently executing */
drh19e2d372005-08-29 23:00:03 +0000484 void (*xTrace)(void*,const char*); /* Trace function */
485 void *pTraceArg; /* Argument to the trace function */
486 void (*xProfile)(void*,const char*,u64); /* Profiling function */
487 void *pProfileArg; /* Argument to profile function */
danielk197771fd80b2005-12-16 06:54:01 +0000488 void *pCommitArg; /* Argument to xCommitCallback() */
489 int (*xCommitCallback)(void*); /* Invoked at every commit. */
490 void *pRollbackArg; /* Argument to xRollbackCallback() */
491 void (*xRollbackCallback)(void*); /* Invoked at every commit. */
danielk197794eb6a12005-12-15 15:22:08 +0000492 void *pUpdateArg;
493 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
drhfcd35c72005-05-21 02:48:08 +0000494 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
495 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
496 void *pCollNeededArg;
drhfcd35c72005-05-21 02:48:08 +0000497 sqlite3_value *pErr; /* Most recent error message */
498 char *zErrMsg; /* Most recent error message (UTF-8 encoded) */
499 char *zErrMsg16; /* Most recent error message (UTF-16 encoded) */
drh881feaa2006-07-26 01:39:30 +0000500 union {
501 int isInterrupted; /* True if sqlite3_interrupt has been called */
502 double notUsed1; /* Spacer */
503 } u1;
drhed6c8672003-01-12 18:02:16 +0000504#ifndef SQLITE_OMIT_AUTHORIZATION
drhe22a3342003-04-22 20:30:37 +0000505 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
506 /* Access authorization function */
drhed6c8672003-01-12 18:02:16 +0000507 void *pAuthArg; /* 1st argument to the access auth function */
508#endif
danielk1977348bb5d2003-10-18 09:37:26 +0000509#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
510 int (*xProgress)(void *); /* The progress callback */
511 void *pProgressArg; /* Argument to the progress callback */
512 int nProgressOps; /* Number of opcodes for progress callback */
513#endif
drhb9bb7c12006-06-11 23:41:55 +0000514#ifndef SQLITE_OMIT_VIRTUALTABLE
515 Hash aModule; /* populated by sqlite3_create_module() */
danielk19777e6ebfb2006-06-12 11:24:37 +0000516 Table *pVTab; /* vtab with active Connect/Create method */
danielk1977f9e7dda2006-06-16 16:08:53 +0000517 sqlite3_vtab **aVTrans; /* Virtual tables with open transactions */
518 int nVTrans; /* Allocated size of aVTrans */
danielk19776b456a22005-03-21 04:04:02 +0000519#endif
drhfcd35c72005-05-21 02:48:08 +0000520 Hash aFunc; /* All functions that can be in SQL exprs */
521 Hash aCollSeq; /* All collating sequences */
522 BusyHandler busyHandler; /* Busy callback */
drhb9bb7c12006-06-11 23:41:55 +0000523 int busyTimeout; /* Busy handler timeout, in msec */
drhfcd35c72005-05-21 02:48:08 +0000524 Db aDbStatic[2]; /* Static space for the 2 default backends */
danielk19777e900ab2005-05-23 04:51:01 +0000525#ifdef SQLITE_SSE
526 sqlite3_stmt *pFetch; /* Used by SSE to fetch stored statements */
527#endif
danielk197741483462007-03-24 16:45:04 +0000528 u8 dfltLockMode; /* Default locking-mode for attached dbs */
drh75897232000-05-29 14:26:00 +0000529};
530
drh03b808a2006-03-13 15:06:05 +0000531/*
532** A macro to discover the encoding of a database.
533*/
danielk197714db2662006-01-09 16:12:04 +0000534#define ENC(db) ((db)->aDb[0].pSchema->enc)
535
drh75897232000-05-29 14:26:00 +0000536/*
drh8bf8dc92003-05-17 17:35:10 +0000537** Possible values for the sqlite.flags and or Db.flags fields.
538**
539** On sqlite.flags, the SQLITE_InTrans value means that we have
540** executed a BEGIN. On Db.flags, SQLITE_InTrans means a statement
541** transaction is active on that particular database file.
drh75897232000-05-29 14:26:00 +0000542*/
drh5e00f6c2001-09-13 13:46:56 +0000543#define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */
drh5e00f6c2001-09-13 13:46:56 +0000544#define SQLITE_InTrans 0x00000008 /* True if in a transaction */
545#define SQLITE_InternChanges 0x00000010 /* Uncommitted Hash table changes */
drh382c0242001-10-06 16:33:02 +0000546#define SQLITE_FullColNames 0x00000020 /* Show full column names on SELECT */
drhfcabd462004-02-20 14:50:58 +0000547#define SQLITE_ShortColNames 0x00000040 /* Show short columns names */
548#define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */
drh1bee3d72001-10-15 00:44:35 +0000549 /* DELETE, or UPDATE and return */
550 /* the count using a callback. */
drhfcabd462004-02-20 14:50:58 +0000551#define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */
drh6a535342001-10-19 16:44:56 +0000552 /* result set is empty */
drh35d4c2f2004-06-10 01:30:59 +0000553#define SQLITE_SqlTrace 0x00000200 /* Debug print SQL as it executes */
554#define SQLITE_VdbeListing 0x00000400 /* Debug listings of VDBE programs */
drhf4040832004-10-22 20:29:21 +0000555#define SQLITE_WriteSchema 0x00000800 /* OK to update SQLITE_MASTER */
drh7bec5052005-02-06 02:45:41 +0000556#define SQLITE_NoReadlock 0x00001000 /* Readlocks are omitted when
557 ** accessing read-only databases */
drh0cd2d4c2005-11-03 02:15:02 +0000558#define SQLITE_IgnoreChecks 0x00002000 /* Do not enforce check constraints */
drhc2e87a32006-06-27 15:16:14 +0000559#define SQLITE_ReadUncommitted 0x00004000 /* For shared-cache mode */
drhe321c292006-01-12 01:56:43 +0000560#define SQLITE_LegacyFileFmt 0x00008000 /* Create new databases in format 1 */
drhac530b12006-02-11 01:25:50 +0000561#define SQLITE_FullFSync 0x00010000 /* Use full fsync on the backend */
drhc2e87a32006-06-27 15:16:14 +0000562#define SQLITE_LoadExtension 0x00020000 /* Enable load_extension */
drh58b95762000-06-02 01:17:37 +0000563
danielk197734c68fb2007-03-14 15:37:04 +0000564#define SQLITE_RecoveryMode 0x00040000 /* Ignore schema errors */
565
drh58b95762000-06-02 01:17:37 +0000566/*
drh247be432002-05-10 05:44:55 +0000567** Possible values for the sqlite.magic field.
568** The numbers are obtained at random and have no special meaning, other
569** than being distinct from one another.
570*/
571#define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */
572#define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */
573#define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */
574#define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */
575
576/*
drh0bce8352002-02-28 00:41:10 +0000577** Each SQL function is defined by an instance of the following
578** structure. A pointer to this structure is stored in the sqlite.aFunc
drh8e0a2f92002-02-23 23:45:45 +0000579** hash table. When multiple functions have the same name, the hash table
580** points to a linked list of these structures.
drh28037572000-08-02 13:47:41 +0000581*/
drh0bce8352002-02-28 00:41:10 +0000582struct FuncDef {
drh55ef4d92005-08-14 01:20:37 +0000583 i16 nArg; /* Number of arguments. -1 means unlimited */
danielk1977d8123362004-06-12 09:25:12 +0000584 u8 iPrefEnc; /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
drh55ef4d92005-08-14 01:20:37 +0000585 u8 needCollSeq; /* True if sqlite3GetFuncCollSeq() might be called */
586 u8 flags; /* Some combination of SQLITE_FUNC_* */
drhf9b596e2004-05-26 16:54:42 +0000587 void *pUserData; /* User data parameter */
588 FuncDef *pNext; /* Next function with same name */
589 void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
590 void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
591 void (*xFinalize)(sqlite3_context*); /* Aggregate finializer */
drh55ef4d92005-08-14 01:20:37 +0000592 char zName[1]; /* SQL name of the function. MUST BE LAST */
drh8e0a2f92002-02-23 23:45:45 +0000593};
drh28037572000-08-02 13:47:41 +0000594
595/*
danielk1977d1ab1ba2006-06-15 04:28:13 +0000596** Each SQLite module (virtual table definition) is defined by an
597** instance of the following structure, stored in the sqlite3.aModule
598** hash table.
599*/
600struct Module {
601 const sqlite3_module *pModule; /* Callback pointers */
602 const char *zName; /* Name passed to create_module() */
603 void *pAux; /* pAux passed to create_module() */
604};
605
606/*
drh55ef4d92005-08-14 01:20:37 +0000607** Possible values for FuncDef.flags
608*/
drhd64fe2f2005-08-28 17:00:23 +0000609#define SQLITE_FUNC_LIKE 0x01 /* Candidate for the LIKE optimization */
610#define SQLITE_FUNC_CASE 0x02 /* Case-sensitive LIKE-type function */
drhb7f6f682006-07-08 17:06:43 +0000611#define SQLITE_FUNC_EPHEM 0x04 /* Ephermeral. Delete with VDBE */
drh55ef4d92005-08-14 01:20:37 +0000612
613/*
drh967e8b72000-06-21 13:59:10 +0000614** information about each column of an SQL table is held in an instance
drh7020f652000-06-03 18:06:52 +0000615** of this structure.
616*/
617struct Column {
drh967e8b72000-06-21 13:59:10 +0000618 char *zName; /* Name of this column */
danielk19777977a172004-11-09 12:44:37 +0000619 Expr *pDflt; /* Default value of this column */
drh382c0242001-10-06 16:33:02 +0000620 char *zType; /* Data type for this column */
danielk1977b3bf5562006-01-10 17:58:23 +0000621 char *zColl; /* Collating sequence. If NULL, use the default */
drh4a324312001-12-21 14:30:42 +0000622 u8 notNull; /* True if there is a NOT NULL constraint */
drh78100cc2003-08-23 22:40:53 +0000623 u8 isPrimKey; /* True if this column is part of the PRIMARY KEY */
danielk1977a37cdde2004-05-16 11:15:36 +0000624 char affinity; /* One of the SQLITE_AFF_... values */
drh7020f652000-06-03 18:06:52 +0000625};
626
627/*
drha9fd84b2004-05-18 23:21:35 +0000628** A "Collating Sequence" is defined by an instance of the following
danielk19770202b292004-06-09 09:55:16 +0000629** structure. Conceptually, a collating sequence consists of a name and
630** a comparison routine that defines the order of that sequence.
drha9fd84b2004-05-18 23:21:35 +0000631**
danielk19770202b292004-06-09 09:55:16 +0000632** There may two seperate implementations of the collation function, one
633** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
634** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
635** native byte order. When a collation sequence is invoked, SQLite selects
636** the version that will require the least expensive encoding
danielk1977b3bf5562006-01-10 17:58:23 +0000637** translations, if any.
danielk19770202b292004-06-09 09:55:16 +0000638**
639** The CollSeq.pUser member variable is an extra parameter that passed in
640** as the first argument to the UTF-8 comparison function, xCmp.
641** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
642** xCmp16.
643**
644** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
645** collating sequence is undefined. Indices built on an undefined
646** collating sequence may not be read or written.
drha9fd84b2004-05-18 23:21:35 +0000647*/
648struct CollSeq {
danielk19770202b292004-06-09 09:55:16 +0000649 char *zName; /* Name of the collating sequence, UTF-8 encoded */
danielk1977466be562004-06-10 02:16:01 +0000650 u8 enc; /* Text encoding handled by xCmp() */
drhd64fe2f2005-08-28 17:00:23 +0000651 u8 type; /* One of the SQLITE_COLL_... values below */
drha9fd84b2004-05-18 23:21:35 +0000652 void *pUser; /* First argument to xCmp() */
danielk19770202b292004-06-09 09:55:16 +0000653 int (*xCmp)(void*,int, const void*, int, const void*);
drha9fd84b2004-05-18 23:21:35 +0000654};
655
656/*
drhd64fe2f2005-08-28 17:00:23 +0000657** Allowed values of CollSeq flags:
658*/
659#define SQLITE_COLL_BINARY 1 /* The default memcmp() collating sequence */
660#define SQLITE_COLL_NOCASE 2 /* The built-in NOCASE collating sequence */
661#define SQLITE_COLL_REVERSE 3 /* The built-in REVERSE collating sequence */
662#define SQLITE_COLL_USER 0 /* Any other user-defined collating sequence */
663
664/*
drhd3d39e92004-05-20 22:16:29 +0000665** A sort order can be either ASC or DESC.
drh8e2ca022002-06-17 17:07:19 +0000666*/
drh8e2ca022002-06-17 17:07:19 +0000667#define SQLITE_SO_ASC 0 /* Sort in ascending order */
drhd3d39e92004-05-20 22:16:29 +0000668#define SQLITE_SO_DESC 1 /* Sort in ascending order */
drh8e2ca022002-06-17 17:07:19 +0000669
670/*
danielk1977a37cdde2004-05-16 11:15:36 +0000671** Column affinity types.
drh8a512562005-11-14 22:29:05 +0000672**
673** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
674** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve
675** the speed a little by number the values consecutively.
676**
677** But rather than start with 0 or 1, we begin with 'a'. That way,
678** when multiple affinity types are concatenated into a string and
679** used as the P3 operand, they will be more readable.
680**
681** Note also that the numeric types are grouped together so that testing
682** for a numeric type is a single comparison.
danielk1977a37cdde2004-05-16 11:15:36 +0000683*/
drh8a512562005-11-14 22:29:05 +0000684#define SQLITE_AFF_TEXT 'a'
685#define SQLITE_AFF_NONE 'b'
686#define SQLITE_AFF_NUMERIC 'c'
687#define SQLITE_AFF_INTEGER 'd'
688#define SQLITE_AFF_REAL 'e'
danielk1977a37cdde2004-05-16 11:15:36 +0000689
drh8a512562005-11-14 22:29:05 +0000690#define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC)
danielk1977a37cdde2004-05-16 11:15:36 +0000691
692/*
drh22f70c32002-02-18 01:17:00 +0000693** Each SQL table is represented in memory by an instance of the
694** following structure.
695**
drhd24cc422003-03-27 12:51:24 +0000696** Table.zName is the name of the table. The case of the original
drh22f70c32002-02-18 01:17:00 +0000697** CREATE TABLE statement is stored, but case is not significant for
698** comparisons.
699**
drhd24cc422003-03-27 12:51:24 +0000700** Table.nCol is the number of columns in this table. Table.aCol is a
drh22f70c32002-02-18 01:17:00 +0000701** pointer to an array of Column structures, one for each column.
702**
drhd24cc422003-03-27 12:51:24 +0000703** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
704** the column that is that key. Otherwise Table.iPKey is negative. Note
drh22f70c32002-02-18 01:17:00 +0000705** that the datatype of the PRIMARY KEY must be INTEGER for this field to
706** be set. An INTEGER PRIMARY KEY is used as the rowid for each row of
707** the table. If a table has no INTEGER PRIMARY KEY, then a random rowid
drhd24cc422003-03-27 12:51:24 +0000708** is generated for each row of the table. Table.hasPrimKey is true if
drh22f70c32002-02-18 01:17:00 +0000709** the table has any PRIMARY KEY, INTEGER or otherwise.
710**
drhd24cc422003-03-27 12:51:24 +0000711** Table.tnum is the page number for the root BTree page of the table in the
712** database file. If Table.iDb is the index of the database table backend
713** in sqlite.aDb[]. 0 is for the main database and 1 is for the file that
drhb9bb7c12006-06-11 23:41:55 +0000714** holds temporary tables and indices. If Table.isEphem
drh22f70c32002-02-18 01:17:00 +0000715** is true, then the table is stored in a file that is automatically deleted
drhd24cc422003-03-27 12:51:24 +0000716** when the VDBE cursor to the table is closed. In this case Table.tnum
drh22f70c32002-02-18 01:17:00 +0000717** refers VDBE cursor number that holds the table open, not to the root
718** page number. Transient tables are used to hold the results of a
719** sub-query that appears instead of a real table name in the FROM clause
720** of a SELECT statement.
drh75897232000-05-29 14:26:00 +0000721*/
722struct Table {
drh967e8b72000-06-21 13:59:10 +0000723 char *zName; /* Name of the table */
drh967e8b72000-06-21 13:59:10 +0000724 int nCol; /* Number of columns in this table */
725 Column *aCol; /* Information about each column */
drhc8392582001-12-31 02:48:51 +0000726 int iPKey; /* If not less then 0, use aCol[iPKey] as the primary key */
drh967e8b72000-06-21 13:59:10 +0000727 Index *pIndex; /* List of SQL indexes on this table. */
drh22f70c32002-02-18 01:17:00 +0000728 int tnum; /* Root BTree node for this table (see note above) */
drha76b5df2002-02-23 02:32:10 +0000729 Select *pSelect; /* NULL for tables. Points to definition if a view. */
drhed8a3bb2005-06-06 21:19:56 +0000730 int nRef; /* Number of pointers to this Table */
danielk1977c3f9bad2002-05-15 08:30:12 +0000731 Trigger *pTrigger; /* List of SQL triggers on this table */
drhc2eef3b2002-08-31 18:53:06 +0000732 FKey *pFKey; /* Linked list of all foreign keys in this table */
danielk19773d1bfea2004-05-14 11:00:53 +0000733 char *zColAff; /* String defining the affinity of each column */
drhffe07b22005-11-03 00:41:17 +0000734#ifndef SQLITE_OMIT_CHECK
735 Expr *pCheck; /* The AND of all CHECK constraints */
736#endif
danielk197719a8e7e2005-03-17 05:03:38 +0000737#ifndef SQLITE_OMIT_ALTERTABLE
738 int addColOffset; /* Offset in CREATE TABLE statement to add a new column */
739#endif
drh19146192006-06-26 19:10:32 +0000740 u8 readOnly; /* True if this table should not be written by the user */
741 u8 isEphem; /* True if created using OP_OpenEphermeral */
742 u8 hasPrimKey; /* True if there exists a primary key */
743 u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */
744 u8 autoInc; /* True if the integer primary key is autoincrement */
drhe09daa92006-06-10 13:29:31 +0000745#ifndef SQLITE_OMIT_VIRTUALTABLE
drh19146192006-06-26 19:10:32 +0000746 u8 isVirtual; /* True if this is a virtual table */
747 u8 isCommit; /* True once the CREATE TABLE has been committed */
danielk1977d1ab1ba2006-06-15 04:28:13 +0000748 Module *pMod; /* Pointer to the implementation of the module */
drhb9bb7c12006-06-11 23:41:55 +0000749 sqlite3_vtab *pVtab; /* Pointer to the module instance */
750 int nModuleArg; /* Number of arguments to the module */
751 char **azModuleArg; /* Text of all module args. [0] is module name */
drhe09daa92006-06-10 13:29:31 +0000752#endif
danielk1977e501b892006-01-09 06:29:47 +0000753 Schema *pSchema;
drh75897232000-05-29 14:26:00 +0000754};
755
756/*
drh4cbdda92006-06-14 19:00:20 +0000757** Test to see whether or not a table is a virtual table. This is
758** done as a macro so that it will be optimized out when virtual
759** table support is omitted from the build.
760*/
761#ifndef SQLITE_OMIT_VIRTUALTABLE
762# define IsVirtual(X) ((X)->isVirtual)
763#else
764# define IsVirtual(X) 0
765#endif
766
767/*
drhc2eef3b2002-08-31 18:53:06 +0000768** Each foreign key constraint is an instance of the following structure.
769**
770** A foreign key is associated with two tables. The "from" table is
771** the table that contains the REFERENCES clause that creates the foreign
772** key. The "to" table is the table that is named in the REFERENCES clause.
773** Consider this example:
774**
775** CREATE TABLE ex1(
776** a INTEGER PRIMARY KEY,
777** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
778** );
779**
780** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
781**
782** Each REFERENCES clause generates an instance of the following structure
783** which is attached to the from-table. The to-table need not exist when
784** the from-table is created. The existance of the to-table is not checked
785** until an attempt is made to insert data into the from-table.
786**
drhea1ba172003-04-20 00:00:23 +0000787** The sqlite.aFKey hash table stores pointers to this structure
drhc2eef3b2002-08-31 18:53:06 +0000788** given the name of a to-table. For each to-table, all foreign keys
789** associated with that table are on a linked list using the FKey.pNextTo
790** field.
791*/
792struct FKey {
793 Table *pFrom; /* The table that constains the REFERENCES clause */
794 FKey *pNextFrom; /* Next foreign key in pFrom */
795 char *zTo; /* Name of table that the key points to */
796 FKey *pNextTo; /* Next foreign key that points to zTo */
797 int nCol; /* Number of columns in this key */
798 struct sColMap { /* Mapping of columns in pFrom to columns in zTo */
799 int iFrom; /* Index of column in pFrom */
800 char *zCol; /* Name of column in zTo. If 0 use PRIMARY KEY */
801 } *aCol; /* One entry for each of nCol column s */
802 u8 isDeferred; /* True if constraint checking is deferred till COMMIT */
803 u8 updateConf; /* How to resolve conflicts that occur on UPDATE */
804 u8 deleteConf; /* How to resolve conflicts that occur on DELETE */
805 u8 insertConf; /* How to resolve conflicts that occur on INSERT */
806};
807
808/*
809** SQLite supports many different ways to resolve a contraint
drh22f70c32002-02-18 01:17:00 +0000810** error. ROLLBACK processing means that a constraint violation
drh0bd1f4e2002-06-06 18:54:39 +0000811** causes the operation in process to fail and for the current transaction
drh1c928532002-01-31 15:54:21 +0000812** to be rolled back. ABORT processing means the operation in process
813** fails and any prior changes from that one operation are backed out,
814** but the transaction is not rolled back. FAIL processing means that
815** the operation in progress stops and returns an error code. But prior
816** changes due to the same operation are not backed out and no rollback
817** occurs. IGNORE means that the particular row that caused the constraint
818** error is not inserted or updated. Processing continues and no error
819** is returned. REPLACE means that preexisting database rows that caused
820** a UNIQUE constraint violation are removed so that the new insert or
821** update can proceed. Processing continues and no error is reported.
drhc2eef3b2002-08-31 18:53:06 +0000822**
823** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
824** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
825** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign
826** key is set to NULL. CASCADE means that a DELETE or UPDATE of the
827** referenced table row is propagated into the row that holds the
828** foreign key.
drh1c928532002-01-31 15:54:21 +0000829**
drh968af522003-02-11 14:55:40 +0000830** The following symbolic values are used to record which type
drh1c928532002-01-31 15:54:21 +0000831** of action to take.
drh9cfcf5d2002-01-29 18:41:24 +0000832*/
drh1c928532002-01-31 15:54:21 +0000833#define OE_None 0 /* There is no constraint to check */
834#define OE_Rollback 1 /* Fail the operation and rollback the transaction */
835#define OE_Abort 2 /* Back out changes but do no rollback transaction */
836#define OE_Fail 3 /* Stop the operation but leave all prior changes */
837#define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */
838#define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */
drhc2eef3b2002-08-31 18:53:06 +0000839
840#define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
841#define OE_SetNull 7 /* Set the foreign key value to NULL */
842#define OE_SetDflt 8 /* Set the foreign key value to its default */
843#define OE_Cascade 9 /* Cascade the changes */
844
845#define OE_Default 99 /* Do whatever the default action is */
drh9cfcf5d2002-01-29 18:41:24 +0000846
drhd3d39e92004-05-20 22:16:29 +0000847
848/*
849** An instance of the following structure is passed as the first
850** argument to sqlite3VdbeKeyCompare and is used to control the
851** comparison of the two index keys.
852**
853** If the KeyInfo.incrKey value is true and the comparison would
drh7e627792005-04-29 02:10:00 +0000854** otherwise be equal, then return a result as if the second key
855** were larger.
drhd3d39e92004-05-20 22:16:29 +0000856*/
857struct KeyInfo {
danielk1977b1bc9532004-05-22 03:05:33 +0000858 u8 enc; /* Text encoding - one of the TEXT_Utf* values */
drhd3d39e92004-05-20 22:16:29 +0000859 u8 incrKey; /* Increase 2nd key by epsilon before comparison */
860 int nField; /* Number of entries in aColl[] */
drhd2d4a6b2006-01-10 15:18:27 +0000861 u8 *aSortOrder; /* If defined an aSortOrder[i] is true, sort DESC */
drhd3d39e92004-05-20 22:16:29 +0000862 CollSeq *aColl[1]; /* Collating sequence for each term of the key */
863};
864
drh9cfcf5d2002-01-29 18:41:24 +0000865/*
drh66b89c82000-11-28 20:47:17 +0000866** Each SQL index is represented in memory by an
drh75897232000-05-29 14:26:00 +0000867** instance of the following structure.
drh967e8b72000-06-21 13:59:10 +0000868**
869** The columns of the table that are to be indexed are described
870** by the aiColumn[] field of this structure. For example, suppose
871** we have the following table and index:
872**
873** CREATE TABLE Ex1(c1 int, c2 int, c3 text);
874** CREATE INDEX Ex2 ON Ex1(c3,c1);
875**
876** In the Table structure describing Ex1, nCol==3 because there are
877** three columns in the table. In the Index structure describing
878** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
879** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the
880** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
881** The second column to be indexed (c1) has an index of 0 in
882** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
drhea1ba172003-04-20 00:00:23 +0000883**
884** The Index.onError field determines whether or not the indexed columns
885** must be unique and what to do if they are not. When Index.onError=OE_None,
886** it means this is not a unique index. Otherwise it is a unique index
887** and the value of Index.onError indicate the which conflict resolution
888** algorithm to employ whenever an attempt is made to insert a non-unique
889** element.
drh75897232000-05-29 14:26:00 +0000890*/
891struct Index {
drh967e8b72000-06-21 13:59:10 +0000892 char *zName; /* Name of this index */
drh967e8b72000-06-21 13:59:10 +0000893 int nColumn; /* Number of columns in the table used by this index */
894 int *aiColumn; /* Which columns are used by this index. 1st is 0 */
drh8b3d9902005-08-19 00:14:42 +0000895 unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
drh967e8b72000-06-21 13:59:10 +0000896 Table *pTable; /* The SQL table being indexed */
drhbe0072d2001-09-13 14:46:09 +0000897 int tnum; /* Page containing root of this index in database file */
drh9cfcf5d2002-01-29 18:41:24 +0000898 u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
drh485b39b2002-07-13 03:11:52 +0000899 u8 autoIndex; /* True if is automatically created (ex: by UNIQUE) */
danielk1977a37cdde2004-05-16 11:15:36 +0000900 char *zColAff; /* String defining the affinity of each column */
drh967e8b72000-06-21 13:59:10 +0000901 Index *pNext; /* The next index associated with the same table */
danielk1977b3bf5562006-01-10 17:58:23 +0000902 Schema *pSchema; /* Schema containing this index */
903 u8 *aSortOrder; /* Array of size Index.nColumn. True==DESC, False==ASC */
904 char **azColl; /* Array of collation sequence names for index */
drh75897232000-05-29 14:26:00 +0000905};
906
907/*
908** Each token coming out of the lexer is an instance of
drh4b59ab52002-08-24 18:24:51 +0000909** this structure. Tokens are also used as part of an expression.
drh4efc4752004-01-16 15:55:37 +0000910**
911** Note if Token.z==0 then Token.dyn and Token.n are undefined and
912** may contain random values. Do not make any assuptions about Token.dyn
913** and Token.n when Token.z==0.
drh75897232000-05-29 14:26:00 +0000914*/
915struct Token {
drh4c755c02004-08-08 20:22:17 +0000916 const unsigned char *z; /* Text of the token. Not NULL-terminated! */
917 unsigned dyn : 1; /* True for malloced memory, false for static */
918 unsigned n : 31; /* Number of characters in this token */
drh75897232000-05-29 14:26:00 +0000919};
920
921/*
drh13449892005-09-07 21:22:45 +0000922** An instance of this structure contains information needed to generate
923** code for a SELECT that contains aggregate functions.
924**
925** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
926** pointer to this structure. The Expr.iColumn field is the index in
927** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
928** code for that node.
929**
930** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
931** original Select structure that describes the SELECT statement. These
932** fields do not need to be freed when deallocating the AggInfo structure.
933*/
934struct AggInfo {
935 u8 directMode; /* Direct rendering mode means take data directly
936 ** from source tables rather than from accumulators */
937 u8 useSortingIdx; /* In direct mode, reference the sorting index rather
938 ** than the source table */
939 int sortingIdx; /* Cursor number of the sorting index */
940 ExprList *pGroupBy; /* The group by clause */
941 int nSortingColumn; /* Number of columns in the sorting index */
942 struct AggInfo_col { /* For each column used in source tables */
danielk19770817d0d2007-02-14 09:19:36 +0000943 Table *pTab; /* Source table */
drh13449892005-09-07 21:22:45 +0000944 int iTable; /* Cursor number of the source table */
945 int iColumn; /* Column number within the source table */
946 int iSorterColumn; /* Column number in the sorting index */
947 int iMem; /* Memory location that acts as accumulator */
drh5774b802005-09-07 22:48:16 +0000948 Expr *pExpr; /* The original expression */
drh13449892005-09-07 21:22:45 +0000949 } *aCol;
950 int nColumn; /* Number of used entries in aCol[] */
951 int nColumnAlloc; /* Number of slots allocated for aCol[] */
952 int nAccumulator; /* Number of columns that show through to the output.
953 ** Additional columns are used only as parameters to
954 ** aggregate functions */
955 struct AggInfo_func { /* For each aggregate function */
956 Expr *pExpr; /* Expression encoding the function */
957 FuncDef *pFunc; /* The aggregate function implementation */
958 int iMem; /* Memory location that acts as accumulator */
drhb9bb7c12006-06-11 23:41:55 +0000959 int iDistinct; /* Ephermeral table used to enforce DISTINCT */
drh13449892005-09-07 21:22:45 +0000960 } *aFunc;
961 int nFunc; /* Number of entries in aFunc[] */
962 int nFuncAlloc; /* Number of slots allocated for aFunc[] */
963};
964
965/*
drh75897232000-05-29 14:26:00 +0000966** Each node of an expression in the parse tree is an instance
drh22f70c32002-02-18 01:17:00 +0000967** of this structure.
968**
969** Expr.op is the opcode. The integer parser token codes are reused
970** as opcodes here. For example, the parser defines TK_GE to be an integer
971** code representing the ">=" operator. This same integer code is reused
972** to represent the greater-than-or-equal-to operator in the expression
973** tree.
974**
975** Expr.pRight and Expr.pLeft are subexpressions. Expr.pList is a list
976** of argument if the expression is a function.
977**
drh4b59ab52002-08-24 18:24:51 +0000978** Expr.token is the operator token for this node. For some expressions
979** that have subexpressions, Expr.token can be the complete text that gave
980** rise to the Expr. In the latter case, the token is marked as being
981** a compound token.
drh22f70c32002-02-18 01:17:00 +0000982**
983** An expression of the form ID or ID.ID refers to a column in a table.
984** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
985** the integer cursor number of a VDBE cursor pointing to that table and
986** Expr.iColumn is the column number for the specific column. If the
987** expression is used as a result in an aggregate SELECT, then the
988** value is also stored in the Expr.iAgg column in the aggregate so that
989** it can be accessed after all aggregates are computed.
990**
991** If the expression is a function, the Expr.iTable is an integer code
drh7c972de2003-09-06 22:18:07 +0000992** representing which function. If the expression is an unbound variable
993** marker (a question mark character '?' in the original SQL) then the
994** Expr.iTable holds the index number for that variable.
drh22f70c32002-02-18 01:17:00 +0000995**
drh1398ad32005-01-19 23:24:50 +0000996** If the expression is a subquery then Expr.iColumn holds an integer
997** register number containing the result of the subquery. If the
998** subquery gives a constant result, then iTable is -1. If the subquery
999** gives a different answer at different times during statement processing
1000** then iTable is the address of a subroutine that computes the subquery.
1001**
drh22f70c32002-02-18 01:17:00 +00001002** The Expr.pSelect field points to a SELECT statement. The SELECT might
1003** be the right operand of an IN operator. Or, if a scalar SELECT appears
1004** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
1005** operand.
danielk1977aee18ef2005-03-09 12:26:50 +00001006**
1007** If the Expr is of type OP_Column, and the table it is selecting from
1008** is a disk table or the "old.*" pseudo-table, then pTab points to the
1009** corresponding table definition.
drh75897232000-05-29 14:26:00 +00001010*/
1011struct Expr {
drh1cc093c2002-06-24 22:01:57 +00001012 u8 op; /* Operation performed by this node */
drha9fd84b2004-05-18 23:21:35 +00001013 char affinity; /* The affinity of the column or 0 if not a column */
drh6a03a1c2006-07-08 18:34:59 +00001014 u16 flags; /* Various flags. See below */
drhf2bc0132004-10-04 13:19:23 +00001015 CollSeq *pColl; /* The collation type of the column or 0 */
drh75897232000-05-29 14:26:00 +00001016 Expr *pLeft, *pRight; /* Left and right subnodes */
drhd99f7062002-06-08 23:25:08 +00001017 ExprList *pList; /* A list of expressions used as function arguments
1018 ** or in "<expr> IN (<expr-list)" */
drh75897232000-05-29 14:26:00 +00001019 Token token; /* An operand token */
drh6977fea2002-10-22 23:38:04 +00001020 Token span; /* Complete text of the expression */
drh967e8b72000-06-21 13:59:10 +00001021 int iTable, iColumn; /* When op==TK_COLUMN, then this expr node means the
drh8e2ca022002-06-17 17:07:19 +00001022 ** iColumn-th field of the iTable-th table. */
drh13449892005-09-07 21:22:45 +00001023 AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
1024 int iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
drh22d6a532005-09-19 21:05:48 +00001025 int iRightJoinTable; /* If EP_FromJoin, the right table of the join */
drhd99f7062002-06-08 23:25:08 +00001026 Select *pSelect; /* When the expression is a sub-select. Also the
1027 ** right side of "<expr> IN (<select>)" */
danielk1977aee18ef2005-03-09 12:26:50 +00001028 Table *pTab; /* Table for OP_Column expressions. */
danielk1977e501b892006-01-09 06:29:47 +00001029 Schema *pSchema;
drh75897232000-05-29 14:26:00 +00001030};
1031
1032/*
drh1f162302002-10-27 19:35:33 +00001033** The following are the meanings of bits in the Expr.flags field.
1034*/
drh392e5972005-07-08 14:14:22 +00001035#define EP_FromJoin 0x01 /* Originated in ON or USING clause of a join */
1036#define EP_Agg 0x02 /* Contains one or more aggregate functions */
1037#define EP_Resolved 0x04 /* IDs have been resolved to COLUMNs */
1038#define EP_Error 0x08 /* Expression contains one or more errors */
drhfd357972005-09-09 01:33:19 +00001039#define EP_Distinct 0x10 /* Aggregate function with DISTINCT keyword */
drh392e5972005-07-08 14:14:22 +00001040#define EP_VarSelect 0x20 /* pSelect is correlated, not constant */
drhd2687b72005-08-12 22:56:09 +00001041#define EP_Dequoted 0x40 /* True if the string has been dequoted */
drh6a03a1c2006-07-08 18:34:59 +00001042#define EP_InfixFunc 0x80 /* True for an infix function: LIKE, GLOB, etc */
drh8b4c40d2007-02-01 23:02:45 +00001043#define EP_ExpCollate 0x100 /* Collating sequence specified explicitly */
drh1f162302002-10-27 19:35:33 +00001044
1045/*
1046** These macros can be used to test, set, or clear bits in the
1047** Expr.flags field.
1048*/
1049#define ExprHasProperty(E,P) (((E)->flags&(P))==(P))
1050#define ExprHasAnyProperty(E,P) (((E)->flags&(P))!=0)
1051#define ExprSetProperty(E,P) (E)->flags|=(P)
1052#define ExprClearProperty(E,P) (E)->flags&=~(P)
1053
1054/*
drh75897232000-05-29 14:26:00 +00001055** A list of expressions. Each expression may optionally have a
1056** name. An expr/name combination can be used in several ways, such
1057** as the list of "expr AS ID" fields following a "SELECT" or in the
1058** list of "ID = expr" items in an UPDATE. A list of expressions can
drhad3cab52002-05-24 02:04:32 +00001059** also be used as the argument to a function, in which case the a.zName
drh75897232000-05-29 14:26:00 +00001060** field is not used.
1061*/
1062struct ExprList {
1063 int nExpr; /* Number of expressions on the list */
drh4305d102003-07-30 12:34:12 +00001064 int nAlloc; /* Number of entries allocated below */
drh9d2985c2005-09-08 01:58:42 +00001065 int iECursor; /* VDBE Cursor associated with this ExprList */
drh6d4abfb2001-10-22 02:58:08 +00001066 struct ExprList_item {
drh75897232000-05-29 14:26:00 +00001067 Expr *pExpr; /* The list of expressions */
1068 char *zName; /* Token associated with this expression */
drh8e2ca022002-06-17 17:07:19 +00001069 u8 sortOrder; /* 1 for DESC or 0 for ASC */
1070 u8 isAgg; /* True if this is an aggregate like count(*) */
1071 u8 done; /* A flag to indicate when processing is finished */
drh75897232000-05-29 14:26:00 +00001072 } *a; /* One entry for each expression */
1073};
1074
1075/*
drhad3cab52002-05-24 02:04:32 +00001076** An instance of this structure can hold a simple list of identifiers,
1077** such as the list "a,b,c" in the following statements:
1078**
1079** INSERT INTO t(a,b,c) VALUES ...;
1080** CREATE INDEX idx ON t(a,b,c);
1081** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1082**
1083** The IdList.a.idx field is used when the IdList represents the list of
1084** column names after a table name in an INSERT statement. In the statement
1085**
1086** INSERT INTO t(a,b,c) ...
1087**
1088** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
drh75897232000-05-29 14:26:00 +00001089*/
1090struct IdList {
drh6d4abfb2001-10-22 02:58:08 +00001091 struct IdList_item {
drhad3cab52002-05-24 02:04:32 +00001092 char *zName; /* Name of the identifier */
drh967e8b72000-06-21 13:59:10 +00001093 int idx; /* Index in some Table.aCol[] of a column named zName */
drhad3cab52002-05-24 02:04:32 +00001094 } *a;
drh13449892005-09-07 21:22:45 +00001095 int nId; /* Number of identifiers on the list */
1096 int nAlloc; /* Number of entries allocated for a[] below */
drhad3cab52002-05-24 02:04:32 +00001097};
1098
1099/*
drh51669862004-12-18 18:40:26 +00001100** The bitmask datatype defined below is used for various optimizations.
drhca83ac52007-02-01 01:40:44 +00001101**
1102** Changing this from a 64-bit to a 32-bit type limits the number of
1103** tables in a join to 32 instead of 64. But it also reduces the size
1104** of the library by 738 bytes on ix86.
drh51669862004-12-18 18:40:26 +00001105*/
drhca83ac52007-02-01 01:40:44 +00001106typedef u64 Bitmask;
drh51669862004-12-18 18:40:26 +00001107
1108/*
drhad3cab52002-05-24 02:04:32 +00001109** The following structure describes the FROM clause of a SELECT statement.
1110** Each table or subquery in the FROM clause is a separate element of
1111** the SrcList.a[] array.
drhd24cc422003-03-27 12:51:24 +00001112**
1113** With the addition of multiple database support, the following structure
1114** can also be used to describe a particular table such as the table that
1115** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL,
1116** such a table must be a simple name: ID. But in SQLite, the table can
1117** now be identified by a database name, a dot, then the table name: ID.ID.
drhc49de5d2007-01-19 01:06:01 +00001118**
1119** The jointype starts out showing the join type between the current table
1120** and the next table on the list. The parser builds the list this way.
1121** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
1122** jointype expresses the join between the table and the previous table.
drhad3cab52002-05-24 02:04:32 +00001123*/
1124struct SrcList {
drh939a16d2004-07-15 13:37:22 +00001125 i16 nSrc; /* Number of tables or subqueries in the FROM clause */
1126 i16 nAlloc; /* Number of entries allocated in a[] below */
drhad3cab52002-05-24 02:04:32 +00001127 struct SrcList_item {
drh113088e2003-03-20 01:16:58 +00001128 char *zDatabase; /* Name of database holding this table */
drhad3cab52002-05-24 02:04:32 +00001129 char *zName; /* Name of the table */
1130 char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */
drhdaffd0e2001-04-11 14:28:42 +00001131 Table *pTab; /* An SQL table corresponding to zName */
1132 Select *pSelect; /* A SELECT statement used in place of a table name */
danielk19771787cca2006-02-10 07:07:14 +00001133 u8 isPopulated; /* Temporary table associated with SELECT is populated */
drhc49de5d2007-01-19 01:06:01 +00001134 u8 jointype; /* Type of join between this able and the previous */
drhe68fbe72007-02-13 12:49:24 +00001135 int iCursor; /* The VDBE cursor number used to access this table */
drhad3cab52002-05-24 02:04:32 +00001136 Expr *pOn; /* The ON clause of a join */
1137 IdList *pUsing; /* The USING clause of a join */
drh51669862004-12-18 18:40:26 +00001138 Bitmask colUsed; /* Bit N (1<<N) set if column N or pTab is used */
drh113088e2003-03-20 01:16:58 +00001139 } a[1]; /* One entry for each identifier on the list */
drh75897232000-05-29 14:26:00 +00001140};
1141
1142/*
drh01f3f252002-05-24 16:14:15 +00001143** Permitted values of the SrcList.a.jointype field
1144*/
1145#define JT_INNER 0x0001 /* Any kind of inner or cross join */
drh3dec2232005-09-10 15:28:09 +00001146#define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */
1147#define JT_NATURAL 0x0004 /* True for a "natural" join */
1148#define JT_LEFT 0x0008 /* Left outer join */
1149#define JT_RIGHT 0x0010 /* Right outer join */
1150#define JT_OUTER 0x0020 /* The "OUTER" keyword is present */
1151#define JT_ERROR 0x0040 /* unknown or unsupported join type */
drh01f3f252002-05-24 16:14:15 +00001152
1153/*
drh6b563442001-11-07 16:48:26 +00001154** For each nested loop in a WHERE clause implementation, the WhereInfo
1155** structure contains a single instance of this structure. This structure
1156** is intended to be private the the where.c module and should not be
1157** access or modified by other modules.
drh6d209d82006-06-27 01:54:26 +00001158**
1159** The pIdxInfo and pBestIdx fields are used to help pick the best
1160** index on a virtual table. The pIdxInfo pointer contains indexing
1161** information for the i-th table in the FROM clause before reordering.
1162** All the pIdxInfo pointers are freed by whereInfoFree() in where.c.
1163** The pBestIdx pointer is a copy of pIdxInfo for the i-th table after
1164** FROM clause ordering. This is a little confusing so I will repeat
1165** it in different words. WhereInfo.a[i].pIdxInfo is index information
1166** for WhereInfo.pTabList.a[i]. WhereInfo.a[i].pBestInfo is the
1167** index information for the i-th loop of the join. pBestInfo is always
1168** either NULL or a copy of some pIdxInfo. So for cleanup it is
1169** sufficient to free all of the pIdxInfo pointers.
1170**
drh6b563442001-11-07 16:48:26 +00001171*/
1172struct WhereLevel {
drh29dda4a2005-07-21 18:23:20 +00001173 int iFrom; /* Which entry in the FROM clause */
1174 int flags; /* Flags associated with this level */
drh51147ba2005-07-23 22:59:55 +00001175 int iMem; /* First memory cell used by this level */
drh29dda4a2005-07-21 18:23:20 +00001176 int iLeftJoin; /* Memory cell used to implement LEFT OUTER JOIN */
1177 Index *pIdx; /* Index used. NULL if no index */
1178 int iTabCur; /* The VDBE cursor used to access the table */
1179 int iIdxCur; /* The VDBE cursor used to acesss pIdx */
1180 int brk; /* Jump here to break out of the loop */
drh72e8fa42007-03-28 14:30:06 +00001181 int nxt; /* Jump here to start the next IN combination */
drh29dda4a2005-07-21 18:23:20 +00001182 int cont; /* Jump here to continue with the next loop cycle */
1183 int top; /* First instruction of interior of the loop */
1184 int op, p1, p2; /* Opcode used to terminate the loop */
drh51147ba2005-07-23 22:59:55 +00001185 int nEq; /* Number of == or IN constraints on this loop */
drhe23399f2005-07-22 00:31:39 +00001186 int nIn; /* Number of IN operators constraining this loop */
drh72e8fa42007-03-28 14:30:06 +00001187 struct InLoop {
1188 int iCur; /* The VDBE cursor used by this IN operator */
1189 int topAddr; /* Top of the IN loop */
1190 } *aInLoop; /* Information about each nested IN operator */
drh6d209d82006-06-27 01:54:26 +00001191 sqlite3_index_info *pBestIdx; /* Index information for this level */
1192
1193 /* The following field is really not part of the current level. But
1194 ** we need a place to cache index information for each table in the
1195 ** FROM clause and the WhereLevel structure is a convenient place.
1196 */
1197 sqlite3_index_info *pIdxInfo; /* Index info for n-th source table */
drh6b563442001-11-07 16:48:26 +00001198};
1199
1200/*
drh75897232000-05-29 14:26:00 +00001201** The WHERE clause processing routine has two halves. The
1202** first part does the start of the WHERE loop and the second
1203** half does the tail of the WHERE loop. An instance of
1204** this structure is returned by the first half and passed
1205** into the second half to give some continuity.
1206*/
1207struct WhereInfo {
1208 Parse *pParse;
drhad3cab52002-05-24 02:04:32 +00001209 SrcList *pTabList; /* List of tables in the join */
drh9012bcb2004-12-19 00:11:35 +00001210 int iTop; /* The very beginning of the WHERE loop */
drh19a775c2000-06-05 18:54:46 +00001211 int iContinue; /* Jump here to continue with next record */
1212 int iBreak; /* Jump here to break out of the loop */
drh6b563442001-11-07 16:48:26 +00001213 int nLevel; /* Number of nested loop */
drh6d209d82006-06-27 01:54:26 +00001214 sqlite3_index_info **apInfo; /* Array of pointers to index info structures */
drh6b563442001-11-07 16:48:26 +00001215 WhereLevel a[1]; /* Information about each nest loop in the WHERE */
drh75897232000-05-29 14:26:00 +00001216};
1217
1218/*
danielk1977b3bce662005-01-29 08:32:43 +00001219** A NameContext defines a context in which to resolve table and column
1220** names. The context consists of a list of tables (the pSrcList) field and
1221** a list of named expression (pEList). The named expression list may
1222** be NULL. The pSrc corresponds to the FROM clause of a SELECT or
1223** to the table being operated on by INSERT, UPDATE, or DELETE. The
1224** pEList corresponds to the result set of a SELECT and is NULL for
1225** other statements.
1226**
1227** NameContexts can be nested. When resolving names, the inner-most
1228** context is searched first. If no match is found, the next outer
1229** context is checked. If there is still no match, the next context
1230** is checked. This process continues until either a match is found
1231** or all contexts are check. When a match is found, the nRef member of
1232** the context containing the match is incremented.
1233**
1234** Each subquery gets a new NameContext. The pNext field points to the
1235** NameContext in the parent query. Thus the process of scanning the
1236** NameContext list corresponds to searching through successively outer
1237** subqueries looking for a match.
1238*/
1239struct NameContext {
1240 Parse *pParse; /* The parser */
1241 SrcList *pSrcList; /* One or more tables used to resolve names */
1242 ExprList *pEList; /* Optional list of named expressions */
1243 int nRef; /* Number of names resolved by this context */
1244 int nErr; /* Number of errors encountered while resolving names */
1245 u8 allowAgg; /* Aggregate functions allowed here */
drh13449892005-09-07 21:22:45 +00001246 u8 hasAgg; /* True if aggregates are seen */
drh06f65412005-11-03 02:03:13 +00001247 u8 isCheck; /* True if resolving names in a CHECK constraint */
danielk1977b3bce662005-01-29 08:32:43 +00001248 int nDepth; /* Depth of subquery recursion. 1 for no recursion */
drh13449892005-09-07 21:22:45 +00001249 AggInfo *pAggInfo; /* Information about aggregates at this level */
danielk1977b3bce662005-01-29 08:32:43 +00001250 NameContext *pNext; /* Next outer name context. NULL for outermost */
1251};
1252
1253/*
drh9bb61fe2000-06-05 16:01:39 +00001254** An instance of the following structure contains all information
1255** needed to generate code for a single SELECT statement.
drha76b5df2002-02-23 02:32:10 +00001256**
drhd11d3822002-06-21 23:01:49 +00001257** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0.
1258** If there is a LIMIT clause, the parser sets nLimit to the value of the
1259** limit and nOffset to the value of the offset (or 0 if there is not
1260** offset). But later on, nLimit and nOffset become the memory locations
1261** in the VDBE that record the limit and offset counters.
drh0342b1f2005-09-01 03:07:44 +00001262**
drhb9bb7c12006-06-11 23:41:55 +00001263** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
drh0342b1f2005-09-01 03:07:44 +00001264** These addresses must be stored so that we can go back and fill in
1265** the P3_KEYINFO and P2 parameters later. Neither the KeyInfo nor
1266** the number of columns in P2 can be computed at the same time
drhb9bb7c12006-06-11 23:41:55 +00001267** as the OP_OpenEphm instruction is coded because not
drh0342b1f2005-09-01 03:07:44 +00001268** enough information about the compound query is known at that point.
drhb9bb7c12006-06-11 23:41:55 +00001269** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
1270** for the result set. The KeyInfo for addrOpenTran[2] contains collating
drh0342b1f2005-09-01 03:07:44 +00001271** sequences for the ORDER BY clause.
drh9bb61fe2000-06-05 16:01:39 +00001272*/
1273struct Select {
drh9bb61fe2000-06-05 16:01:39 +00001274 ExprList *pEList; /* The fields of the result */
drh7b58dae2003-07-20 01:16:46 +00001275 u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
1276 u8 isDistinct; /* True if the DISTINCT keyword is present */
drh0342b1f2005-09-01 03:07:44 +00001277 u8 isResolved; /* True once sqlite3SelectResolve() has run. */
1278 u8 isAgg; /* True if this is an aggregate query */
drhb9bb7c12006-06-11 23:41:55 +00001279 u8 usesEphm; /* True if uses an OpenEphemeral opcode */
drh4b14b4d2005-09-19 17:35:53 +00001280 u8 disallowOrderBy; /* Do not allow an ORDER BY to be attached if TRUE */
drh6c1426f2007-04-12 03:54:38 +00001281 char affinity; /* MakeRecord with this affinity for SRT_Set */
drhad3cab52002-05-24 02:04:32 +00001282 SrcList *pSrc; /* The FROM clause */
drh9bb61fe2000-06-05 16:01:39 +00001283 Expr *pWhere; /* The WHERE clause */
1284 ExprList *pGroupBy; /* The GROUP BY clause */
1285 Expr *pHaving; /* The HAVING clause */
1286 ExprList *pOrderBy; /* The ORDER BY clause */
drh967e8b72000-06-21 13:59:10 +00001287 Select *pPrior; /* Prior select in a compound select statement */
drh0342b1f2005-09-01 03:07:44 +00001288 Select *pRightmost; /* Right-most select in a compound select statement */
danielk1977a2dc3b12005-02-05 12:48:48 +00001289 Expr *pLimit; /* LIMIT expression. NULL means not used. */
1290 Expr *pOffset; /* OFFSET expression. NULL means not used. */
drh7b58dae2003-07-20 01:16:46 +00001291 int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */
drhb9bb7c12006-06-11 23:41:55 +00001292 int addrOpenEphm[3]; /* OP_OpenEphem opcodes related to this select */
drh9bb61fe2000-06-05 16:01:39 +00001293};
1294
1295/*
drhfef52082000-06-06 01:50:43 +00001296** The results of a select can be distributed in several ways.
1297*/
drh13449892005-09-07 21:22:45 +00001298#define SRT_Union 1 /* Store result as keys in an index */
1299#define SRT_Except 2 /* Remove result from a UNION index */
1300#define SRT_Discard 3 /* Do not save the results anywhere */
drhfef52082000-06-06 01:50:43 +00001301
drh13449892005-09-07 21:22:45 +00001302/* The ORDER BY clause is ignored for all of the above */
1303#define IgnorableOrderby(X) (X<=SRT_Discard)
1304
1305#define SRT_Callback 4 /* Invoke a callback with each row of result */
1306#define SRT_Mem 5 /* Store result in a memory cell */
1307#define SRT_Set 6 /* Store non-null results as keys in an index */
drhd49c16e2005-09-08 02:00:25 +00001308#define SRT_Table 7 /* Store result as data with an automatic rowid */
drhb9bb7c12006-06-11 23:41:55 +00001309#define SRT_EphemTab 8 /* Create transient tab and store like SRT_Table */
drh9d2985c2005-09-08 01:58:42 +00001310#define SRT_Subroutine 9 /* Call a subroutine to handle results */
drhec7429a2005-10-06 16:53:14 +00001311#define SRT_Exists 10 /* Store 1 if the result is not empty */
drh22827922000-06-06 17:27:05 +00001312
1313/*
drhf57b3392001-10-08 13:22:32 +00001314** An SQL parser context. A copy of this structure is passed through
1315** the parser and down into all the parser action routine in order to
1316** carry around information that is global to the entire parse.
drhf1974842004-11-05 03:56:00 +00001317**
1318** The structure is divided into two parts. When the parser and code
1319** generate call themselves recursively, the first part of the structure
1320** is constant but the second part is reset at the beginning and end of
1321** each recursion.
danielk1977c00da102006-01-07 13:21:04 +00001322**
1323** The nTableLock and aTableLock variables are only used if the shared-cache
1324** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
1325** used to store the set of table-locks required by the statement being
1326** compiled. Function sqlite3TableLock() is used to add entries to the
1327** list.
drh75897232000-05-29 14:26:00 +00001328*/
1329struct Parse {
drh9bb575f2004-09-06 17:24:11 +00001330 sqlite3 *db; /* The main database structure */
drh4c504392000-10-16 22:06:40 +00001331 int rc; /* Return code from execution */
drh75897232000-05-29 14:26:00 +00001332 char *zErrMsg; /* An error message */
drh75897232000-05-29 14:26:00 +00001333 Vdbe *pVdbe; /* An engine for executing database bytecode */
drh836faa42003-01-11 13:30:57 +00001334 u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */
drhe0bc4042002-06-25 01:09:11 +00001335 u8 nameClash; /* A permanent table name clashes with temp table name */
drha6ecd332004-06-10 00:29:09 +00001336 u8 checkSchema; /* Causes schema cookie check after an error */
drh205f48e2004-11-05 00:43:11 +00001337 u8 nested; /* Number of nested calls to the parser/code generator */
drh86dac2b2006-05-25 12:17:31 +00001338 u8 parseError; /* True if a parsing error has been seen */
drh75897232000-05-29 14:26:00 +00001339 int nErr; /* Number of errors seen */
drh832508b2002-03-02 17:04:07 +00001340 int nTab; /* Number of previously allocated VDBE cursors */
drh19a775c2000-06-05 18:54:46 +00001341 int nMem; /* Number of memory cells used so far */
drhfef52082000-06-06 01:50:43 +00001342 int nSet; /* Number of sets used so far */
drhffe07b22005-11-03 00:41:17 +00001343 int ckOffset; /* Stack offset to data used by CHECK constraints */
drh80242052004-06-09 00:48:12 +00001344 u32 writeMask; /* Start a write transaction on these databases */
drhfcd35c72005-05-21 02:48:08 +00001345 u32 cookieMask; /* Bitmask of schema verified databases */
1346 int cookieGoto; /* Address of OP_Goto to cookie verifier subroutine */
1347 int cookieValue[MAX_ATTACHED+2]; /* Values of cookies to verify */
danielk1977c00da102006-01-07 13:21:04 +00001348#ifndef SQLITE_OMIT_SHARED_CACHE
1349 int nTableLock; /* Number of locks in aTableLock */
1350 TableLock *aTableLock; /* Required table locks for shared-cache mode */
1351#endif
drhf1974842004-11-05 03:56:00 +00001352
1353 /* Above is constant between recursions. Below is reset before and after
1354 ** each recursion */
1355
1356 int nVar; /* Number of '?' variables seen in the SQL so far */
1357 int nVarExpr; /* Number of used slots in apVarExpr[] */
1358 int nVarExprAlloc; /* Number of allocated slots in apVarExpr[] */
1359 Expr **apVarExpr; /* Pointers to :aaa and $aaaa wildcard expressions */
1360 u8 explain; /* True if the EXPLAIN flag is found on the query */
drhf1974842004-11-05 03:56:00 +00001361 Token sErrToken; /* The token at which the error occurred */
1362 Token sNameToken; /* Token with unqualified schema object name */
1363 Token sLastToken; /* The last token parsed */
1364 const char *zSql; /* All SQL text */
1365 const char *zTail; /* All SQL text past the last semicolon parsed */
1366 Table *pNewTable; /* A table being constructed by CREATE TABLE */
1367 Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */
1368 TriggerStack *trigStack; /* Trigger actions being coded */
1369 const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
drhb9bb7c12006-06-11 23:41:55 +00001370#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk197733b39332006-06-24 08:51:05 +00001371 Token sArg; /* Complete text of a module argument */
danielk1977f9e7dda2006-06-16 16:08:53 +00001372 u8 declareVtab; /* True if inside sqlite3_declare_vtab() */
1373 Table *pVirtualLock; /* Require virtual table lock on this table */
drhb9bb7c12006-06-11 23:41:55 +00001374#endif
drh75897232000-05-29 14:26:00 +00001375};
1376
danielk19777e6ebfb2006-06-12 11:24:37 +00001377#ifdef SQLITE_OMIT_VIRTUALTABLE
1378 #define IN_DECLARE_VTAB 0
1379#else
1380 #define IN_DECLARE_VTAB (pParse->declareVtab)
1381#endif
1382
danielk1977d99bc932002-05-16 00:13:12 +00001383/*
drh85e20962003-04-25 17:52:11 +00001384** An instance of the following structure can be declared on a stack and used
1385** to save the Parse.zAuthContext value so that it can be restored later.
1386*/
1387struct AuthContext {
1388 const char *zAuthContext; /* Put saved Parse.zAuthContext here */
1389 Parse *pParse; /* The Parse structure */
1390};
1391
1392/*
drhf0863fe2005-06-12 21:35:51 +00001393** Bitfield flags for P2 value in OP_Insert and OP_Delete
rdcb0c374f2004-02-20 22:53:38 +00001394*/
1395#define OPFLAG_NCHANGE 1 /* Set to update db->nChange */
1396#define OPFLAG_LASTROWID 2 /* Set to update db->lastRowid */
danielk197794eb6a12005-12-15 15:22:08 +00001397#define OPFLAG_ISUPDATE 4 /* This OP_Insert is an sql UPDATE */
drhe4d90812007-03-29 05:51:49 +00001398#define OPFLAG_APPEND 8 /* This is likely to be an append */
rdcb0c374f2004-02-20 22:53:38 +00001399
1400/*
danielk1977d99bc932002-05-16 00:13:12 +00001401 * Each trigger present in the database schema is stored as an instance of
1402 * struct Trigger.
1403 *
1404 * Pointers to instances of struct Trigger are stored in two ways.
drh9bb575f2004-09-06 17:24:11 +00001405 * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
danielk1977d99bc932002-05-16 00:13:12 +00001406 * database). This allows Trigger structures to be retrieved by name.
1407 * 2. All triggers associated with a single table form a linked list, using the
drhad3cab52002-05-24 02:04:32 +00001408 * pNext member of struct Trigger. A pointer to the first element of the
1409 * linked list is stored as the "pTrigger" member of the associated
1410 * struct Table.
danielk1977d99bc932002-05-16 00:13:12 +00001411 *
drhad3cab52002-05-24 02:04:32 +00001412 * The "step_list" member points to the first element of a linked list
1413 * containing the SQL statements specified as the trigger program.
danielk1977d99bc932002-05-16 00:13:12 +00001414 */
danielk1977c3f9bad2002-05-15 08:30:12 +00001415struct Trigger {
drhdc379452002-05-15 12:45:43 +00001416 char *name; /* The name of the trigger */
1417 char *table; /* The table or view to which the trigger applies */
drhf0f258b2003-04-21 18:48:45 +00001418 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */
drhdca76842004-12-07 14:06:13 +00001419 u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
drhdc379452002-05-15 12:45:43 +00001420 Expr *pWhen; /* The WHEN clause of the expresion (may be NULL) */
1421 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger,
danielk1977d99bc932002-05-16 00:13:12 +00001422 the <column-list> is stored here */
drh4312db52003-06-03 01:47:11 +00001423 Token nameToken; /* Token containing zName. Use during parsing only */
danielk1977e501b892006-01-09 06:29:47 +00001424 Schema *pSchema; /* Schema containing the trigger */
1425 Schema *pTabSchema; /* Schema containing the table */
drhdc379452002-05-15 12:45:43 +00001426 TriggerStep *step_list; /* Link list of trigger program steps */
drhdc379452002-05-15 12:45:43 +00001427 Trigger *pNext; /* Next trigger associated with the table */
danielk1977c3f9bad2002-05-15 08:30:12 +00001428};
1429
danielk1977d99bc932002-05-16 00:13:12 +00001430/*
drhdca76842004-12-07 14:06:13 +00001431** A trigger is either a BEFORE or an AFTER trigger. The following constants
1432** determine which.
1433**
1434** If there are multiple triggers, you might of some BEFORE and some AFTER.
1435** In that cases, the constants below can be ORed together.
1436*/
1437#define TRIGGER_BEFORE 1
1438#define TRIGGER_AFTER 2
1439
1440/*
danielk1977d99bc932002-05-16 00:13:12 +00001441 * An instance of struct TriggerStep is used to store a single SQL statement
1442 * that is a part of a trigger-program.
1443 *
1444 * Instances of struct TriggerStep are stored in a singly linked list (linked
1445 * using the "pNext" member) referenced by the "step_list" member of the
1446 * associated struct Trigger instance. The first element of the linked list is
1447 * the first step of the trigger-program.
1448 *
1449 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
1450 * "SELECT" statement. The meanings of the other members is determined by the
1451 * value of "op" as follows:
1452 *
1453 * (op == TK_INSERT)
1454 * orconf -> stores the ON CONFLICT algorithm
1455 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then
1456 * this stores a pointer to the SELECT statement. Otherwise NULL.
1457 * target -> A token holding the name of the table to insert into.
1458 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
1459 * this stores values to be inserted. Otherwise NULL.
1460 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ...
drhad3cab52002-05-24 02:04:32 +00001461 * statement, then this stores the column-names to be
1462 * inserted into.
danielk1977d99bc932002-05-16 00:13:12 +00001463 *
1464 * (op == TK_DELETE)
1465 * target -> A token holding the name of the table to delete from.
1466 * pWhere -> The WHERE clause of the DELETE statement if one is specified.
1467 * Otherwise NULL.
1468 *
1469 * (op == TK_UPDATE)
1470 * target -> A token holding the name of the table to update rows of.
1471 * pWhere -> The WHERE clause of the UPDATE statement if one is specified.
1472 * Otherwise NULL.
1473 * pExprList -> A list of the columns to update and the expressions to update
danielk19774adee202004-05-08 08:23:19 +00001474 * them to. See sqlite3Update() documentation of "pChanges"
drhad3cab52002-05-24 02:04:32 +00001475 * argument.
danielk1977d99bc932002-05-16 00:13:12 +00001476 *
1477 */
1478struct TriggerStep {
1479 int op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1480 int orconf; /* OE_Rollback etc. */
drha69d9162003-04-17 22:57:53 +00001481 Trigger *pTrig; /* The trigger that this step is a part of */
danielk1977c3f9bad2002-05-15 08:30:12 +00001482
danielk1977d99bc932002-05-16 00:13:12 +00001483 Select *pSelect; /* Valid for SELECT and sometimes
1484 INSERT steps (when pExprList == 0) */
1485 Token target; /* Valid for DELETE, UPDATE, INSERT steps */
1486 Expr *pWhere; /* Valid for DELETE, UPDATE steps */
1487 ExprList *pExprList; /* Valid for UPDATE statements and sometimes
1488 INSERT steps (when pSelect == 0) */
1489 IdList *pIdList; /* Valid for INSERT statements only */
drh187e4c62006-02-27 22:22:27 +00001490 TriggerStep *pNext; /* Next in the link-list */
1491 TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */
danielk1977d99bc932002-05-16 00:13:12 +00001492};
1493
1494/*
1495 * An instance of struct TriggerStack stores information required during code
1496 * generation of a single trigger program. While the trigger program is being
1497 * coded, its associated TriggerStack instance is pointed to by the
1498 * "pTriggerStack" member of the Parse structure.
1499 *
1500 * The pTab member points to the table that triggers are being coded on. The
1501 * newIdx member contains the index of the vdbe cursor that points at the temp
1502 * table that stores the new.* references. If new.* references are not valid
1503 * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1504 * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1505 *
1506 * The ON CONFLICT policy to be used for the trigger program steps is stored
1507 * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1508 * specified for individual triggers steps is used.
1509 *
1510 * struct TriggerStack has a "pNext" member, to allow linked lists to be
1511 * constructed. When coding nested triggers (triggers fired by other triggers)
1512 * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1513 * pointer. Once the nested trigger has been coded, the pNext value is restored
1514 * to the pTriggerStack member of the Parse stucture and coding of the parent
1515 * trigger continues.
1516 *
1517 * Before a nested trigger is coded, the linked list pointed to by the
1518 * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1519 * recursively. If this condition is detected, the nested trigger is not coded.
1520 */
1521struct TriggerStack {
1522 Table *pTab; /* Table that triggers are currently being coded on */
1523 int newIdx; /* Index of vdbe cursor to "new" temp table */
1524 int oldIdx; /* Index of vdbe cursor to "old" temp table */
1525 int orconf; /* Current orconf policy */
danielk19776f349032002-06-11 02:25:40 +00001526 int ignoreJump; /* where to jump to for a RAISE(IGNORE) */
drhe22a3342003-04-22 20:30:37 +00001527 Trigger *pTrigger; /* The trigger currently being coded */
1528 TriggerStack *pNext; /* Next trigger down on the trigger stack */
danielk1977d99bc932002-05-16 00:13:12 +00001529};
1530
1531/*
drhf26e09c2003-05-31 16:21:12 +00001532** The following structure contains information used by the sqliteFix...
1533** routines as they walk the parse tree to make database references
1534** explicit.
1535*/
1536typedef struct DbFixer DbFixer;
1537struct DbFixer {
1538 Parse *pParse; /* The parsing context. Error messages written here */
1539 const char *zDb; /* Make sure all objects are contained in this database */
1540 const char *zType; /* Type of the container - used for error messages */
1541 const Token *pName; /* Name of the container - used for error messages */
1542};
1543
1544/*
drh234c39d2004-07-24 03:30:47 +00001545** A pointer to this structure is used to communicate information
1546** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
1547*/
1548typedef struct {
drh9bb575f2004-09-06 17:24:11 +00001549 sqlite3 *db; /* The database being initialized */
drhece3c722006-09-23 20:36:01 +00001550 int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */
drh234c39d2004-07-24 03:30:47 +00001551 char **pzErrMsg; /* Error message stored here */
drh15ca1df2006-07-26 13:43:30 +00001552 int rc; /* Result code stored here */
drh234c39d2004-07-24 03:30:47 +00001553} InitData;
1554
drhb6c29892004-11-22 19:12:19 +00001555/*
danielk1977d99bc932002-05-16 00:13:12 +00001556 * This global flag is set for performance testing of triggers. When it is set
1557 * SQLite will perform the overhead of building new and old trigger references
1558 * even when no triggers exist
1559 */
drh38f82712004-06-18 17:10:16 +00001560extern int sqlite3_always_code_trigger_setup;
danielk1977c3f9bad2002-05-15 08:30:12 +00001561
drh75897232000-05-29 14:26:00 +00001562/*
drh49285702005-09-17 15:20:26 +00001563** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production
1564** builds) or a function call (for debugging). If it is a function call,
1565** it allows the operator to set a breakpoint at the spot where database
1566** corruption is first detected.
1567*/
1568#ifdef SQLITE_DEBUG
1569 extern int sqlite3Corrupt(void);
1570# define SQLITE_CORRUPT_BKPT sqlite3Corrupt()
1571#else
1572# define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT
1573#endif
1574
1575/*
drh75897232000-05-29 14:26:00 +00001576** Internal function prototypes
1577*/
danielk19774adee202004-05-08 08:23:19 +00001578int sqlite3StrICmp(const char *, const char *);
1579int sqlite3StrNICmp(const char *, const char *, int);
1580int sqlite3HashNoCase(const char *, int);
danielk19778a6b5412004-05-24 07:04:25 +00001581int sqlite3IsNumber(const char*, int*, u8);
danielk19774adee202004-05-08 08:23:19 +00001582int sqlite3Compare(const char *, const char *);
1583int sqlite3SortCompare(const char *, const char *);
1584void sqlite3RealToSortable(double r, char *);
danielk19772e588c72005-12-09 14:25:08 +00001585
danielk1977750b03e2006-02-14 10:48:39 +00001586void *sqlite3Malloc(int,int);
1587void *sqlite3MallocRaw(int,int);
danielk19772e588c72005-12-09 14:25:08 +00001588void sqlite3Free(void*);
1589void *sqlite3Realloc(void*,int);
1590char *sqlite3StrDup(const char*);
1591char *sqlite3StrNDup(const char*, int);
danielk19774adee202004-05-08 08:23:19 +00001592# define sqlite3CheckMemory(a,b)
drhcf643722007-03-27 13:36:37 +00001593void *sqlite3ReallocOrFree(void*,int);
drh998da3a2004-06-19 15:22:56 +00001594void sqlite3FreeX(void*);
drh132d8d62005-05-22 20:12:37 +00001595void *sqlite3MallocX(int);
danielk197713f72992005-12-18 08:51:22 +00001596int sqlite3AllocSize(void *);
danielk19772e588c72005-12-09 14:25:08 +00001597
danielk19774adee202004-05-08 08:23:19 +00001598char *sqlite3MPrintf(const char*, ...);
1599char *sqlite3VMPrintf(const char*, va_list);
drhe54ca3f2004-06-07 01:52:14 +00001600void sqlite3DebugPrintf(const char*, ...);
drhfe63d1c2004-09-08 20:13:04 +00001601void *sqlite3TextToPtr(const char*);
drh41f58522005-06-06 15:06:39 +00001602void sqlite3SetString(char **, ...);
danielk19774adee202004-05-08 08:23:19 +00001603void sqlite3ErrorMsg(Parse*, const char*, ...);
drha0733842005-12-29 01:11:36 +00001604void sqlite3ErrorClear(Parse*);
danielk19774adee202004-05-08 08:23:19 +00001605void sqlite3Dequote(char*);
drhd2687b72005-08-12 22:56:09 +00001606void sqlite3DequoteExpr(Expr*);
drh2646da72005-12-09 20:02:05 +00001607int sqlite3KeywordCode(const unsigned char*, int);
danielk19774adee202004-05-08 08:23:19 +00001608int sqlite3RunParser(Parse*, const char*, char **);
drh80242052004-06-09 00:48:12 +00001609void sqlite3FinishCoding(Parse*);
drhe4e72072004-11-23 01:47:30 +00001610Expr *sqlite3Expr(int, Expr*, Expr*, const Token*);
drh206f3d92006-07-11 13:15:08 +00001611Expr *sqlite3ExprOrFree(int, Expr*, Expr*, const Token*);
drh4e0cff62004-11-05 05:10:28 +00001612Expr *sqlite3RegisterExpr(Parse*,Token*);
drh91bb0ee2004-09-01 03:06:34 +00001613Expr *sqlite3ExprAnd(Expr*, Expr*);
danielk19774adee202004-05-08 08:23:19 +00001614void sqlite3ExprSpan(Expr*,Token*,Token*);
1615Expr *sqlite3ExprFunction(ExprList*, Token*);
drhfa6bc002004-09-07 16:19:52 +00001616void sqlite3ExprAssignVarNumber(Parse*, Expr*);
danielk19774adee202004-05-08 08:23:19 +00001617void sqlite3ExprDelete(Expr*);
1618ExprList *sqlite3ExprListAppend(ExprList*,Expr*,Token*);
1619void sqlite3ExprListDelete(ExprList*);
drh9bb575f2004-09-06 17:24:11 +00001620int sqlite3Init(sqlite3*, char**);
drh234c39d2004-07-24 03:30:47 +00001621int sqlite3InitCallback(void*, int, char**, char**);
danielk197791cf71b2004-06-26 06:37:06 +00001622void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
drh9bb575f2004-09-06 17:24:11 +00001623void sqlite3ResetInternalSchema(sqlite3*, int);
danielk19774adee202004-05-08 08:23:19 +00001624void sqlite3BeginParse(Parse*,int);
drh9bb575f2004-09-06 17:24:11 +00001625void sqlite3CommitInternalChanges(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00001626Table *sqlite3ResultSetOfSelect(Parse*,char*,Select*);
danielk1977c00da102006-01-07 13:21:04 +00001627void sqlite3OpenMasterTable(Parse *, int);
danielk1977f1a381e2006-06-16 08:01:02 +00001628void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
danielk19774adee202004-05-08 08:23:19 +00001629void sqlite3AddColumn(Parse*,Token*);
1630void sqlite3AddNotNull(Parse*, int);
drhfdd6e852005-12-16 01:06:16 +00001631void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
drhffe07b22005-11-03 00:41:17 +00001632void sqlite3AddCheckConstraint(Parse*, Expr*);
drh487e2622005-06-25 18:42:14 +00001633void sqlite3AddColumnType(Parse*,Token*);
danielk19777977a172004-11-09 12:44:37 +00001634void sqlite3AddDefaultValue(Parse*,Expr*);
drhd3d39e92004-05-20 22:16:29 +00001635void sqlite3AddCollateType(Parse*, const char*, int);
danielk197719a8e7e2005-03-17 05:03:38 +00001636void sqlite3EndTable(Parse*,Token*,Token*,Select*);
drhb7f91642004-10-31 02:22:47 +00001637
drhfdd48a72006-09-11 23:45:48 +00001638void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int);
danielk1977fe3fcbe22006-06-12 12:08:45 +00001639
1640#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
drhb7f91642004-10-31 02:22:47 +00001641 int sqlite3ViewGetColumnNames(Parse*,Table*);
1642#else
1643# define sqlite3ViewGetColumnNames(A,B) 0
1644#endif
1645
drha0733842005-12-29 01:11:36 +00001646void sqlite3DropTable(Parse*, SrcList*, int, int);
danielk1977a04a34f2007-04-16 15:06:25 +00001647void sqlite3DeleteTable(Table*);
danielk19774adee202004-05-08 08:23:19 +00001648void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
drhcf643722007-03-27 13:36:37 +00001649void *sqlite3ArrayAllocate(void*,int,int,int*,int*,int*);
danielk19774adee202004-05-08 08:23:19 +00001650IdList *sqlite3IdListAppend(IdList*, Token*);
1651int sqlite3IdListIndex(IdList*,const char*);
1652SrcList *sqlite3SrcListAppend(SrcList*, Token*, Token*);
drh61dfc312006-12-16 16:25:15 +00001653SrcList *sqlite3SrcListAppendFromTerm(SrcList*, Token*, Token*, Token*,
1654 Select*, Expr*, IdList*);
1655void sqlite3SrcListShiftJoinType(SrcList*);
danielk19774adee202004-05-08 08:23:19 +00001656void sqlite3SrcListAssignCursors(Parse*, SrcList*);
1657void sqlite3IdListDelete(IdList*);
1658void sqlite3SrcListDelete(SrcList*);
danielk19770202b292004-06-09 09:55:16 +00001659void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
drh4d91a702006-01-04 15:54:36 +00001660 Token*, int, int);
1661void sqlite3DropIndex(Parse*, SrcList*, int);
danielk19774adee202004-05-08 08:23:19 +00001662void sqlite3AddKeyType(Vdbe*, ExprList*);
1663void sqlite3AddIdxKeyType(Vdbe*, Index*);
danielk1977b3bce662005-01-29 08:32:43 +00001664int sqlite3Select(Parse*, Select*, int, int, Select*, int, int*, char *aff);
danielk19774adee202004-05-08 08:23:19 +00001665Select *sqlite3SelectNew(ExprList*,SrcList*,Expr*,ExprList*,Expr*,ExprList*,
danielk1977a2dc3b12005-02-05 12:48:48 +00001666 int,Expr*,Expr*);
danielk19774adee202004-05-08 08:23:19 +00001667void sqlite3SelectDelete(Select*);
1668void sqlite3SelectUnbind(Select*);
1669Table *sqlite3SrcListLookup(Parse*, SrcList*);
1670int sqlite3IsReadOnly(Parse*, Table*, int);
danielk1977c00da102006-01-07 13:21:04 +00001671void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
danielk19774adee202004-05-08 08:23:19 +00001672void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
1673void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
drhf8db1bc2005-04-22 02:38:37 +00001674WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**);
danielk19774adee202004-05-08 08:23:19 +00001675void sqlite3WhereEnd(WhereInfo*);
drh945498f2007-02-24 11:52:52 +00001676void sqlite3ExprCodeGetColumn(Vdbe*, Table*, int, int);
danielk19774adee202004-05-08 08:23:19 +00001677void sqlite3ExprCode(Parse*, Expr*);
drh25303782004-12-07 15:41:48 +00001678void sqlite3ExprCodeAndCache(Parse*, Expr*);
drhf9b596e2004-05-26 16:54:42 +00001679int sqlite3ExprCodeExprList(Parse*, ExprList*);
danielk19774adee202004-05-08 08:23:19 +00001680void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
1681void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
drh205f48e2004-11-05 00:43:11 +00001682void sqlite3NextedParse(Parse*, const char*, ...);
drh9bb575f2004-09-06 17:24:11 +00001683Table *sqlite3FindTable(sqlite3*,const char*, const char*);
danielk19774adee202004-05-08 08:23:19 +00001684Table *sqlite3LocateTable(Parse*,const char*, const char*);
drh9bb575f2004-09-06 17:24:11 +00001685Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
1686void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
1687void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
drh74161702006-02-24 02:53:49 +00001688void sqlite3Vacuum(Parse*);
drh9bb575f2004-09-06 17:24:11 +00001689int sqlite3RunVacuum(char**, sqlite3*);
drha99db3b2004-06-19 14:49:12 +00001690char *sqlite3NameFromToken(Token*);
danielk19774adee202004-05-08 08:23:19 +00001691int sqlite3ExprCheck(Parse*, Expr*, int, int*);
danielk19774adee202004-05-08 08:23:19 +00001692int sqlite3ExprCompare(Expr*, Expr*);
drhcce7d172000-05-31 15:34:51 +00001693int sqliteFuncId(Token*);
danielk1977b3bce662005-01-29 08:32:43 +00001694int sqlite3ExprResolveNames(NameContext *, Expr *);
danielk1977a58fdfb2005-02-08 07:50:40 +00001695int sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
drh5d9a4af2005-08-30 00:54:01 +00001696int sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
danielk19774adee202004-05-08 08:23:19 +00001697Vdbe *sqlite3GetVdbe(Parse*);
drh9c419382006-06-16 21:13:21 +00001698Expr *sqlite3CreateIdExpr(const char*);
danielk19774adee202004-05-08 08:23:19 +00001699void sqlite3Randomness(int, void*);
drh9bb575f2004-09-06 17:24:11 +00001700void sqlite3RollbackAll(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00001701void sqlite3CodeVerifySchema(Parse*, int);
drh684917c2004-10-05 02:41:42 +00001702void sqlite3BeginTransaction(Parse*, int);
danielk19774adee202004-05-08 08:23:19 +00001703void sqlite3CommitTransaction(Parse*);
1704void sqlite3RollbackTransaction(Parse*);
1705int sqlite3ExprIsConstant(Expr*);
drheb55bd22005-06-30 17:04:21 +00001706int sqlite3ExprIsConstantOrFunction(Expr*);
danielk19774adee202004-05-08 08:23:19 +00001707int sqlite3ExprIsInteger(Expr*, int*);
1708int sqlite3IsRowid(const char*);
drh9bb575f2004-09-06 17:24:11 +00001709void sqlite3GenerateRowDelete(sqlite3*, Vdbe*, Table*, int, int);
drh74161702006-02-24 02:53:49 +00001710void sqlite3GenerateRowIndexDelete(Vdbe*, Table*, int, char*);
drh51846b52004-05-28 16:00:21 +00001711void sqlite3GenerateIndexKey(Vdbe*, Index*, int);
danielk19774adee202004-05-08 08:23:19 +00001712void sqlite3GenerateConstraintChecks(Parse*,Table*,int,char*,int,int,int,int);
drhe4d90812007-03-29 05:51:49 +00001713void sqlite3CompleteInsertion(Parse*, Table*, int, char*, int, int, int, int);
drh290c1942004-08-21 17:54:45 +00001714void sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
danielk19774adee202004-05-08 08:23:19 +00001715void sqlite3BeginWriteOperation(Parse*, int, int);
danielk19774adee202004-05-08 08:23:19 +00001716Expr *sqlite3ExprDup(Expr*);
1717void sqlite3TokenCopy(Token*, Token*);
1718ExprList *sqlite3ExprListDup(ExprList*);
1719SrcList *sqlite3SrcListDup(SrcList*);
1720IdList *sqlite3IdListDup(IdList*);
1721Select *sqlite3SelectDup(Select*);
drh9bb575f2004-09-06 17:24:11 +00001722FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
1723void sqlite3RegisterBuiltinFunctions(sqlite3*);
1724void sqlite3RegisterDateTimeFunctions(sqlite3*);
1725int sqlite3SafetyOn(sqlite3*);
1726int sqlite3SafetyOff(sqlite3*);
1727int sqlite3SafetyCheck(sqlite3*);
1728void sqlite3ChangeCookie(sqlite3*, Vdbe*, int);
drhb7f91642004-10-31 02:22:47 +00001729
1730#ifndef SQLITE_OMIT_TRIGGER
1731 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
drh60218d22007-04-06 11:26:00 +00001732 Expr*,int, int);
drhb7f91642004-10-31 02:22:47 +00001733 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
drhfdd48a72006-09-11 23:45:48 +00001734 void sqlite3DropTrigger(Parse*, SrcList*, int);
drh74161702006-02-24 02:53:49 +00001735 void sqlite3DropTriggerPtr(Parse*, Trigger*);
drhdca76842004-12-07 14:06:13 +00001736 int sqlite3TriggersExist(Parse*, Table*, int, ExprList*);
drhb7f91642004-10-31 02:22:47 +00001737 int sqlite3CodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
1738 int, int);
1739 void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
1740 void sqlite3DeleteTriggerStep(TriggerStep*);
1741 TriggerStep *sqlite3TriggerSelectStep(Select*);
1742 TriggerStep *sqlite3TriggerInsertStep(Token*, IdList*, ExprList*,Select*,int);
1743 TriggerStep *sqlite3TriggerUpdateStep(Token*, ExprList*, Expr*, int);
1744 TriggerStep *sqlite3TriggerDeleteStep(Token*, Expr*);
1745 void sqlite3DeleteTrigger(Trigger*);
1746 void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
1747#else
1748# define sqlite3TriggersExist(A,B,C,D,E,F) 0
1749# define sqlite3DeleteTrigger(A)
drhcdd536f2006-03-17 00:04:03 +00001750# define sqlite3DropTriggerPtr(A,B)
drhb7f91642004-10-31 02:22:47 +00001751# define sqlite3UnlinkAndDeleteTrigger(A,B,C)
1752# define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I) 0
1753#endif
1754
danielk19774adee202004-05-08 08:23:19 +00001755int sqlite3JoinType(Parse*, Token*, Token*, Token*);
danielk19770202b292004-06-09 09:55:16 +00001756void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
danielk19774adee202004-05-08 08:23:19 +00001757void sqlite3DeferForeignKey(Parse*, int);
drhed6c8672003-01-12 18:02:16 +00001758#ifndef SQLITE_OMIT_AUTHORIZATION
danielk19774adee202004-05-08 08:23:19 +00001759 void sqlite3AuthRead(Parse*,Expr*,SrcList*);
1760 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
1761 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
1762 void sqlite3AuthContextPop(AuthContext*);
drhed6c8672003-01-12 18:02:16 +00001763#else
danielk19774adee202004-05-08 08:23:19 +00001764# define sqlite3AuthRead(a,b,c)
1765# define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK
1766# define sqlite3AuthContextPush(a,b,c)
1767# define sqlite3AuthContextPop(a) ((void)(a))
drhed6c8672003-01-12 18:02:16 +00001768#endif
danielk1977f744bb52005-12-06 17:19:11 +00001769void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
1770void sqlite3Detach(Parse*, Expr*);
drh9bb575f2004-09-06 17:24:11 +00001771int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
drh90f5ecb2004-07-22 01:19:35 +00001772 int omitJournal, int nCache, Btree **ppBtree);
danielk19774adee202004-05-08 08:23:19 +00001773int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
1774int sqlite3FixSrcList(DbFixer*, SrcList*);
1775int sqlite3FixSelect(DbFixer*, Select*);
1776int sqlite3FixExpr(DbFixer*, Expr*);
1777int sqlite3FixExprList(DbFixer*, ExprList*);
1778int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
drh487e2622005-06-25 18:42:14 +00001779int sqlite3AtoF(const char *z, double*);
danielk19776f8a5032004-05-10 10:34:51 +00001780char *sqlite3_snprintf(int,char*,const char*,...);
drhfec19aa2004-05-19 20:41:03 +00001781int sqlite3GetInt32(const char *, int*);
drhfec19aa2004-05-19 20:41:03 +00001782int sqlite3FitsIn64Bits(const char *);
danielk19776622cce2004-05-20 11:00:52 +00001783int sqlite3utf16ByteLen(const void *pData, int nChar);
1784int sqlite3utf8CharLen(const char *pData, int nByte);
drh4e5ffc52004-08-31 00:52:37 +00001785int sqlite3ReadUtf8(const unsigned char *);
danielk1977192ac1d2004-05-10 07:17:30 +00001786int sqlite3PutVarint(unsigned char *, u64);
danielk197790e4d952004-05-10 10:05:53 +00001787int sqlite3GetVarint(const unsigned char *, u64 *);
drh6d2fb152004-05-14 16:50:06 +00001788int sqlite3GetVarint32(const unsigned char *, u32 *);
danielk1977192ac1d2004-05-10 07:17:30 +00001789int sqlite3VarintLen(u64 v);
danielk1977a37cdde2004-05-16 11:15:36 +00001790void sqlite3IndexAffinityStr(Vdbe *, Index *);
1791void sqlite3TableAffinityStr(Vdbe *, Table *);
danielk1977e014a832004-05-17 10:48:57 +00001792char sqlite3CompareAffinity(Expr *pExpr, char aff2);
danielk1977e014a832004-05-17 10:48:57 +00001793int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
danielk1977bf3b7212004-05-18 10:06:24 +00001794char sqlite3ExprAffinity(Expr *pExpr);
drheb2e1762004-05-27 01:53:56 +00001795int sqlite3atoi64(const char*, i64*);
drh9bb575f2004-09-06 17:24:11 +00001796void sqlite3Error(sqlite3*, int, const char*,...);
danielk1977cbb18d22004-05-28 11:37:27 +00001797void *sqlite3HexToBlob(const char *z);
danielk1977ef2cb632004-05-29 02:37:19 +00001798int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
danielk1977f20b21c2004-05-31 23:56:42 +00001799const char *sqlite3ErrStr(int);
danielk1977d02eb1f2004-06-06 09:44:03 +00001800int sqlite3ReadUniChar(const char *zStr, int *pOffset, u8 *pEnc, int fold);
danielk19778a414492004-06-29 08:59:35 +00001801int sqlite3ReadSchema(Parse *pParse);
drh9bb575f2004-09-06 17:24:11 +00001802CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
danielk19770202b292004-06-09 09:55:16 +00001803CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
danielk19777cedc8d2004-06-10 10:50:08 +00001804CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
drh8b4c40d2007-02-01 23:02:45 +00001805Expr *sqlite3ExprSetColl(Parse *pParse, Expr *, Token *);
danielk19777cedc8d2004-06-10 10:50:08 +00001806int sqlite3CheckCollSeq(Parse *, CollSeq *);
1807int sqlite3CheckIndexCollSeq(Parse *, Index *);
danielk1977d8123362004-06-12 09:25:12 +00001808int sqlite3CheckObjectName(Parse *, const char *);
danielk1977b28af712004-06-21 06:50:26 +00001809void sqlite3VdbeSetChanges(sqlite3 *, int);
danielk1977f4618892004-06-28 13:09:11 +00001810void sqlite3utf16Substr(sqlite3_context *,int,sqlite3_value **);
danielk19774e6af132004-06-10 14:01:08 +00001811
1812const void *sqlite3ValueText(sqlite3_value*, u8);
1813int sqlite3ValueBytes(sqlite3_value*, u8);
danielk1977bfd6cce2004-06-18 04:24:54 +00001814void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8, void(*)(void*));
danielk19774e6af132004-06-10 14:01:08 +00001815void sqlite3ValueFree(sqlite3_value*);
drh4f26bb62005-09-08 14:17:20 +00001816sqlite3_value *sqlite3ValueNew(void);
drhaf9a7c22005-12-15 03:04:10 +00001817char *sqlite3utf16to8(const void*, int);
danielk1977aee18ef2005-03-09 12:26:50 +00001818int sqlite3ValueFromExpr(Expr *, u8, u8, sqlite3_value **);
1819void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
drh4e5ffc52004-08-31 00:52:37 +00001820extern const unsigned char sqlite3UpperToLower[];
danielk1977a0bf2652004-11-04 14:30:04 +00001821void sqlite3RootPageMoved(Db*, int, int);
drh4343fea2004-11-05 23:46:15 +00001822void sqlite3Reindex(Parse*, Token*, Token*);
drh1f01ec12005-02-15 21:36:18 +00001823void sqlite3AlterFunctions(sqlite3*);
danielk19779fd2a9a2004-11-12 13:42:30 +00001824void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
1825int sqlite3GetToken(const unsigned char *, int *);
drh2958a4e2004-11-12 03:56:15 +00001826void sqlite3NestedParse(Parse*, const char*, ...);
drhd89bd002005-01-22 03:03:54 +00001827void sqlite3ExpirePreparedStatements(sqlite3*);
danielk1977b3bce662005-01-29 08:32:43 +00001828void sqlite3CodeSubselect(Parse *, Expr *);
1829int sqlite3SelectResolve(Parse *, Select *, NameContext *);
danielk1977aee18ef2005-03-09 12:26:50 +00001830void sqlite3ColumnDefault(Vdbe *, Table *, int);
danielk197719a8e7e2005-03-17 05:03:38 +00001831void sqlite3AlterFinishAddColumn(Parse *, Token *);
1832void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
drh2e66f0b2005-04-28 17:18:48 +00001833const char *sqlite3TestErrorName(int);
danielk19774dade032005-05-25 10:45:10 +00001834CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int);
drh8a512562005-11-14 22:29:05 +00001835char sqlite3AffinityType(const Token*);
drh9f18e8a2005-07-08 12:13:04 +00001836void sqlite3Analyze(Parse*, Token*, Token*);
drha4afb652005-07-09 02:16:02 +00001837int sqlite3InvokeBusyHandler(BusyHandler*);
drhff2d5ea2005-07-23 00:41:48 +00001838int sqlite3FindDb(sqlite3*, Token*);
drh497e4462005-07-23 03:18:40 +00001839void sqlite3AnalysisLoad(sqlite3*,int iDB);
drh51147ba2005-07-23 22:59:55 +00001840void sqlite3DefaultRowEst(Index*);
drh55ef4d92005-08-14 01:20:37 +00001841void sqlite3RegisterLikeFunctions(sqlite3*, int);
drhd64fe2f2005-08-28 17:00:23 +00001842int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
drh6f7adc82006-01-11 21:41:20 +00001843ThreadData *sqlite3ThreadData(void);
1844const ThreadData *sqlite3ThreadDataReadOnly(void);
1845void sqlite3ReleaseThreadData(void);
danielk1977f744bb52005-12-06 17:19:11 +00001846void sqlite3AttachFunctions(sqlite3 *);
drhfdd6e852005-12-16 01:06:16 +00001847void sqlite3MinimumFileFormat(Parse*, int, int);
danielk1977da184232006-01-05 11:34:32 +00001848void sqlite3SchemaFree(void *);
danielk1977e501b892006-01-09 06:29:47 +00001849Schema *sqlite3SchemaGet(Btree *);
1850int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
danielk1977b3bf5562006-01-10 17:58:23 +00001851KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *);
danielk1977771151b2006-01-17 13:21:40 +00001852int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
1853 void (*)(sqlite3_context*,int,sqlite3_value **),
1854 void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*));
danielk197754f01982006-01-18 15:25:17 +00001855int sqlite3ApiExit(sqlite3 *db, int);
drhd1167392006-01-23 13:00:35 +00001856int sqlite3MallocFailed(void);
1857void sqlite3FailedMalloc(void);
danielk19778d34dfd2006-01-24 16:37:57 +00001858void sqlite3AbortOtherActiveVdbes(sqlite3 *, Vdbe *);
danielk1977ddfb2f02006-02-17 12:25:14 +00001859int sqlite3OpenTempDatabase(Parse *);
drh69dab1d2006-06-27 14:37:20 +00001860
1861#ifndef SQLITE_OMIT_LOAD_EXTENSION
1862 void sqlite3CloseExtensions(sqlite3*);
drh1409be62006-08-23 20:07:20 +00001863 int sqlite3AutoLoadExtensions(sqlite3*);
drh69dab1d2006-06-27 14:37:20 +00001864#else
1865# define sqlite3CloseExtensions(X)
drh1409be62006-08-23 20:07:20 +00001866# define sqlite3AutoLoadExtensions(X) SQLITE_OK
drh69dab1d2006-06-27 14:37:20 +00001867#endif
danielk1977e3026632004-06-22 11:29:02 +00001868
danielk1977c00da102006-01-07 13:21:04 +00001869#ifndef SQLITE_OMIT_SHARED_CACHE
1870 void sqlite3TableLock(Parse *, int, int, u8, const char *);
1871#else
1872 #define sqlite3TableLock(v,w,x,y,z)
1873#endif
1874
danielk197708659fe2006-01-17 15:36:32 +00001875#ifdef SQLITE_MEMDEBUG
drhd1167392006-01-23 13:00:35 +00001876 void sqlite3MallocDisallow(void);
1877 void sqlite3MallocAllow(void);
1878 int sqlite3TestMallocFail(void);
danielk197708659fe2006-01-17 15:36:32 +00001879#else
drhc93cc422006-01-23 13:28:53 +00001880 #define sqlite3TestMallocFail() 0
1881 #define sqlite3MallocDisallow()
1882 #define sqlite3MallocAllow()
danielk19772e588c72005-12-09 14:25:08 +00001883#endif
1884
danielk1977750b03e2006-02-14 10:48:39 +00001885#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
1886 void *sqlite3ThreadSafeMalloc(int);
1887 void sqlite3ThreadSafeFree(void *);
1888#else
1889 #define sqlite3ThreadSafeMalloc sqlite3MallocX
1890 #define sqlite3ThreadSafeFree sqlite3FreeX
1891#endif
1892
drhb9bb7c12006-06-11 23:41:55 +00001893#ifdef SQLITE_OMIT_VIRTUALTABLE
1894# define sqlite3VtabClear(X)
danielk1977f9e7dda2006-06-16 16:08:53 +00001895# define sqlite3VtabSync(X,Y) (Y)
1896# define sqlite3VtabRollback(X)
1897# define sqlite3VtabCommit(X)
drhb9bb7c12006-06-11 23:41:55 +00001898#else
drh707205d2006-06-17 10:44:42 +00001899 void sqlite3VtabClear(Table*);
danielk1977f9e7dda2006-06-16 16:08:53 +00001900 int sqlite3VtabSync(sqlite3 *db, int rc);
1901 int sqlite3VtabRollback(sqlite3 *db);
1902 int sqlite3VtabCommit(sqlite3 *db);
drhb9bb7c12006-06-11 23:41:55 +00001903#endif
drh189d4af2006-09-02 20:57:52 +00001904void sqlite3VtabLock(sqlite3_vtab*);
danielk1977a04a34f2007-04-16 15:06:25 +00001905void sqlite3VtabUnlock(sqlite3*, sqlite3_vtab*);
drhb9bb7c12006-06-11 23:41:55 +00001906void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*);
1907void sqlite3VtabFinishParse(Parse*, Token*);
1908void sqlite3VtabArgInit(Parse*);
1909void sqlite3VtabArgExtend(Parse*, Token*);
danielk197778efaba2006-06-12 06:09:17 +00001910int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
danielk19777e6ebfb2006-06-12 11:24:37 +00001911int sqlite3VtabCallConnect(Parse*, Table*);
danielk19779e39ce82006-06-12 16:01:21 +00001912int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
danielk1977f9e7dda2006-06-16 16:08:53 +00001913int sqlite3VtabBegin(sqlite3 *, sqlite3_vtab *);
drhb7f6f682006-07-08 17:06:43 +00001914FuncDef *sqlite3VtabOverloadFunction(FuncDef*, int nArg, Expr*);
drhb7481e72006-09-16 21:45:14 +00001915void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
drhb900aaf2006-11-09 00:24:53 +00001916int sqlite3Reprepare(Vdbe*);
drhb9bb7c12006-06-11 23:41:55 +00001917
drha3152892007-05-05 11:48:52 +00001918u32 sqlite3Get2byte(const u8*);
1919u32 sqlite3Get4byte(const u8*);
1920void sqlite3Put2byte(u8*, u32);
1921void sqlite3Put4byte(u8*, u32);
1922
danielk1977fd9a0a42005-05-24 12:01:00 +00001923#ifdef SQLITE_SSE
1924#include "sseInt.h"
1925#endif
1926
drhb0603412007-02-28 04:47:26 +00001927/*
1928** If the SQLITE_ENABLE IOTRACE exists then the global variable
1929** sqlite3_io_trace is a pointer to a printf-like routine used to
1930** print I/O tracing messages.
1931*/
1932#ifdef SQLITE_ENABLE_IOTRACE
1933# define IOTRACE(A) if( sqlite3_io_trace ){ sqlite3_io_trace A; }
danielk1977b4622b62007-03-02 06:24:19 +00001934 void sqlite3VdbeIOTraceSql(Vdbe*);
drhb0603412007-02-28 04:47:26 +00001935#else
1936# define IOTRACE(A)
danielk1977b4622b62007-03-02 06:24:19 +00001937# define sqlite3VdbeIOTraceSql(X)
drhb0603412007-02-28 04:47:26 +00001938#endif
1939extern void (*sqlite3_io_trace)(const char*,...);
1940
danielk1977e3026632004-06-22 11:29:02 +00001941#endif