blob: 3cb1aef99b2e02fa2ce43f40fcffd4319ccaf68a [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**
drh06f65412005-11-03 02:03:13 +000014** @(#) $Id: sqliteInt.h,v 1.426 2005/11/03 02:03:13 drh Exp $
drh75897232000-05-29 14:26:00 +000015*/
danielk1977e3026632004-06-22 11:29:02 +000016#ifndef _SQLITEINT_H_
17#define _SQLITEINT_H_
18
drheb206252004-10-01 02:00:31 +000019/*
drh4b529d92005-09-13 00:00:00 +000020** Many people are failing to set -DNDEBUG=1 when compiling SQLite.
drhb27795c2005-09-13 00:02:16 +000021** Setting NDEBUG makes the code smaller and run faster. So the following
drh4b529d92005-09-13 00:00:00 +000022** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1
23** option is set. Thus NDEBUG becomes an opt-in rather than an opt-out
24** feature.
25*/
drh289ab072005-09-13 16:12:47 +000026#if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
drh4b529d92005-09-13 00:00:00 +000027# define NDEBUG 1
28#endif
29
30/*
drheb206252004-10-01 02:00:31 +000031** These #defines should enable >2GB file support on Posix if the
32** underlying operating system supports it. If the OS lacks
33** large file support, or if the OS is windows, these should be no-ops.
34**
35** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
36** on the compiler command line. This is necessary if you are compiling
37** on a recent machine (ex: RedHat 7.2) but you want your code to work
38** on an older machine (ex: RedHat 6.0). If you compile on RedHat 7.2
39** without this option, LFS is enable. But LFS does not exist in the kernel
40** in RedHat 6.0, so the code won't work. Hence, for maximum binary
41** portability you should omit LFS.
42**
43** Similar is true for MacOS. LFS is only supported on MacOS 9 and later.
44*/
45#ifndef SQLITE_DISABLE_LFS
46# define _LARGE_FILE 1
47# ifndef _FILE_OFFSET_BITS
48# define _FILE_OFFSET_BITS 64
49# endif
50# define _LARGEFILE_SOURCE 1
51#endif
52
drh1d482dd2004-05-31 18:23:07 +000053#include "sqlite3.h"
drhbeae3192001-09-22 18:12:08 +000054#include "hash.h"
drh75897232000-05-29 14:26:00 +000055#include "parse.h"
drh75897232000-05-29 14:26:00 +000056#include <stdio.h>
57#include <stdlib.h>
58#include <string.h>
59#include <assert.h>
drh52370e22005-01-21 21:31:40 +000060#include <stddef.h>
drh75897232000-05-29 14:26:00 +000061
drh967e8b72000-06-21 13:59:10 +000062/*
drhb37df7b2005-10-13 02:09:49 +000063** If compiling for a processor that lacks floating point support,
64** substitute integer for floating-point
65*/
66#ifdef SQLITE_OMIT_FLOATING_POINT
67# define double sqlite_int64
68# define LONGDOUBLE_TYPE sqlite_int64
69# define SQLITE_BIG_DBL (0x7fffffffffffffff)
70# define SQLITE_OMIT_DATETIME_FUNCS 1
71# define SQLITE_OMIT_TRACE 1
72#endif
73
74/*
drha1b351a2001-09-14 16:42:12 +000075** The maximum number of in-memory pages to use for the main database
danielk197724c8ab82005-02-09 01:40:23 +000076** table and for temporary tables. Internally, the MAX_PAGES and
77** TEMP_PAGES macros are used. To override the default values at
78** compilation time, the SQLITE_DEFAULT_CACHE_SIZE and
79** SQLITE_DEFAULT_TEMP_CACHE_SIZE macros should be set.
drha1b351a2001-09-14 16:42:12 +000080*/
drh1ba1e6e2005-01-21 21:22:52 +000081#ifdef SQLITE_DEFAULT_CACHE_SIZE
82# define MAX_PAGES SQLITE_DEFAULT_CACHE_SIZE
83#else
84# define MAX_PAGES 2000
85#endif
danielk197724c8ab82005-02-09 01:40:23 +000086#ifdef SQLITE_DEFAULT_TEMP_CACHE_SIZE
87# define TEMP_PAGES SQLITE_DEFAULT_TEMP_CACHE_SIZE
88#else
89# define TEMP_PAGES 500
90#endif
drha1b351a2001-09-14 16:42:12 +000091
92/*
danielk197753c0f742005-03-29 03:10:59 +000093** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
94** afterward. Having this macro allows us to cause the C compiler
95** to omit code used by TEMP tables without messy #ifndef statements.
96*/
97#ifdef SQLITE_OMIT_TEMPDB
98#define OMIT_TEMPDB 1
99#else
100#define OMIT_TEMPDB 0
101#endif
102
103/*
drh0bd1f4e2002-06-06 18:54:39 +0000104** If the following macro is set to 1, then NULL values are considered
105** distinct for the SELECT DISTINCT statement and for UNION or EXCEPT
106** compound queries. No other SQL database engine (among those tested)
107** works this way except for OCELOT. But the SQL92 spec implies that
108** this is how things should work.
109**
110** If the following macro is set to 0, then NULLs are indistinct for
111** SELECT DISTINCT and for UNION.
112*/
113#define NULL_ALWAYS_DISTINCT 0
114
115/*
116** If the following macro is set to 1, then NULL values are considered
117** distinct when determining whether or not two entries are the same
118** in a UNIQUE index. This is the way PostgreSQL, Oracle, DB2, MySQL,
119** OCELOT, and Firebird all work. The SQL92 spec explicitly says this
120** is the way things are suppose to work.
121**
122** If the following macro is set to 0, the NULLs are indistinct for
123** a UNIQUE index. In this mode, you can only have a single NULL entry
124** for a column declared UNIQUE. This is the way Informix and SQL Server
125** work.
126*/
127#define NULL_DISTINCT_FOR_UNIQUE 1
128
129/*
drh665de472003-03-31 13:36:09 +0000130** The maximum number of attached databases. This must be at least 2
131** in order to support the main database file (0) and the file used to
drh80242052004-06-09 00:48:12 +0000132** hold temporary tables (1). And it must be less than 32 because
133** we use a bitmask of databases with a u32 in places (for example
134** the Parse.cookieMask field).
drh665de472003-03-31 13:36:09 +0000135*/
136#define MAX_ATTACHED 10
137
138/*
drhfa6bc002004-09-07 16:19:52 +0000139** The maximum value of a ?nnn wildcard that the parser will accept.
140*/
141#define SQLITE_MAX_VARIABLE_NUMBER 999
142
143/*
drh49766d62005-01-08 18:42:28 +0000144** Provide a default value for TEMP_STORE in case it is not specified
145** on the command-line
146*/
147#ifndef TEMP_STORE
148# define TEMP_STORE 1
149#endif
150
151/*
drhf1974842004-11-05 03:56:00 +0000152** GCC does not define the offsetof() macro so we'll have to do it
153** ourselves.
154*/
155#ifndef offsetof
156#define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
157#endif
158
159/*
drh5a2c2c22001-11-21 02:21:11 +0000160** Integers of known sizes. These typedefs might change for architectures
161** where the sizes very. Preprocessor macros are available so that the
162** types can be conveniently redefined at compile-type. Like this:
163**
164** cc '-DUINTPTR_TYPE=long long int' ...
drh41a2b482001-01-20 19:52:49 +0000165*/
drh3aac2dd2004-04-26 14:10:20 +0000166#ifndef UINT64_TYPE
drhefad9992004-06-22 12:13:55 +0000167# if defined(_MSC_VER) || defined(__BORLANDC__)
168# define UINT64_TYPE unsigned __int64
169# else
170# define UINT64_TYPE unsigned long long int
171# endif
drh3aac2dd2004-04-26 14:10:20 +0000172#endif
drh5a2c2c22001-11-21 02:21:11 +0000173#ifndef UINT32_TYPE
174# define UINT32_TYPE unsigned int
175#endif
176#ifndef UINT16_TYPE
177# define UINT16_TYPE unsigned short int
178#endif
drh939a16d2004-07-15 13:37:22 +0000179#ifndef INT16_TYPE
180# define INT16_TYPE short int
181#endif
drh5a2c2c22001-11-21 02:21:11 +0000182#ifndef UINT8_TYPE
183# define UINT8_TYPE unsigned char
184#endif
drh905793e2004-02-21 13:31:09 +0000185#ifndef INT8_TYPE
186# define INT8_TYPE signed char
187#endif
drhefad9992004-06-22 12:13:55 +0000188#ifndef LONGDOUBLE_TYPE
189# define LONGDOUBLE_TYPE long double
190#endif
drhefad9992004-06-22 12:13:55 +0000191typedef sqlite_int64 i64; /* 8-byte signed integer */
drh3aac2dd2004-04-26 14:10:20 +0000192typedef UINT64_TYPE u64; /* 8-byte unsigned integer */
drh5a2c2c22001-11-21 02:21:11 +0000193typedef UINT32_TYPE u32; /* 4-byte unsigned integer */
194typedef UINT16_TYPE u16; /* 2-byte unsigned integer */
drh939a16d2004-07-15 13:37:22 +0000195typedef INT16_TYPE i16; /* 2-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000196typedef UINT8_TYPE u8; /* 1-byte unsigned integer */
drh905793e2004-02-21 13:31:09 +0000197typedef UINT8_TYPE i8; /* 1-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000198
199/*
drhbbd42a62004-05-22 17:41:58 +0000200** Macros to determine whether the machine is big or little endian,
201** evaluated at runtime.
202*/
203extern const int sqlite3one;
drh9c054832004-05-31 18:51:57 +0000204#define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0)
205#define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
drhbbd42a62004-05-22 17:41:58 +0000206
207/*
drh90f5ecb2004-07-22 01:19:35 +0000208** An instance of the following structure is used to store the busy-handler
209** callback for a given sqlite handle.
210**
211** The sqlite.busyHandler member of the sqlite struct contains the busy
212** callback for the database handle. Each pager opened via the sqlite
213** handle is passed a pointer to sqlite.busyHandler. The busy-handler
214** callback is currently invoked only from within pager.c.
215*/
216typedef struct BusyHandler BusyHandler;
217struct BusyHandler {
218 int (*xFunc)(void *,int); /* The busy callback */
219 void *pArg; /* First arg to busy callback */
drha4afb652005-07-09 02:16:02 +0000220 int nBusy; /* Incremented with each busy call */
drh90f5ecb2004-07-22 01:19:35 +0000221};
222
223/*
224** Defer sourcing vdbe.h and btree.h until after the "u8" and
225** "BusyHandler typedefs.
drh905793e2004-02-21 13:31:09 +0000226*/
227#include "vdbe.h"
drh3aac2dd2004-04-26 14:10:20 +0000228#include "btree.h"
drh905793e2004-02-21 13:31:09 +0000229
230/*
drh5a2c2c22001-11-21 02:21:11 +0000231** This macro casts a pointer to an integer. Useful for doing
232** pointer arithmetic.
233*/
234#define Addr(X) ((uptr)X)
drh41a2b482001-01-20 19:52:49 +0000235
236/*
drh967e8b72000-06-21 13:59:10 +0000237** If memory allocation problems are found, recompile with
238**
drhfaa57ac2004-06-09 14:01:51 +0000239** -DSQLITE_DEBUG=1
drh967e8b72000-06-21 13:59:10 +0000240**
241** to enable some sanity checking on malloc() and free(). To
242** check for memory leaks, recompile with
243**
drhfaa57ac2004-06-09 14:01:51 +0000244** -DSQLITE_DEBUG=2
drh967e8b72000-06-21 13:59:10 +0000245**
246** and a line of text will be written to standard error for
247** each malloc() and free(). This output can be analyzed
248** by an AWK script to determine if there are any leaks.
249*/
danielk19772c336542005-01-13 02:14:23 +0000250#ifdef SQLITE_MEMDEBUG
danielk19774adee202004-05-08 08:23:19 +0000251# define sqliteMalloc(X) sqlite3Malloc_(X,1,__FILE__,__LINE__)
252# define sqliteMallocRaw(X) sqlite3Malloc_(X,0,__FILE__,__LINE__)
253# define sqliteFree(X) sqlite3Free_(X,__FILE__,__LINE__)
254# define sqliteRealloc(X,Y) sqlite3Realloc_(X,Y,__FILE__,__LINE__)
255# define sqliteStrDup(X) sqlite3StrDup_(X,__FILE__,__LINE__)
256# define sqliteStrNDup(X,Y) sqlite3StrNDup_(X,Y,__FILE__,__LINE__)
drhc3c2fc92000-05-31 22:58:39 +0000257#else
drh38f82712004-06-18 17:10:16 +0000258# define sqliteFree sqlite3FreeX
259# define sqliteMalloc sqlite3Malloc
260# define sqliteMallocRaw sqlite3MallocRaw
261# define sqliteRealloc sqlite3Realloc
drhae29ffb2004-09-25 14:39:18 +0000262# define sqliteStrDup sqlite3StrDup
263# define sqliteStrNDup sqlite3StrNDup
drhdcc581c2000-05-30 13:44:19 +0000264#endif
265
drh75897232000-05-29 14:26:00 +0000266/*
drhdaffd0e2001-04-11 14:28:42 +0000267** This variable gets set if malloc() ever fails. After it gets set,
268** the SQLite library shuts down permanently.
269*/
danielk19776f8a5032004-05-10 10:34:51 +0000270extern int sqlite3_malloc_failed;
drhdaffd0e2001-04-11 14:28:42 +0000271
272/*
drh6e142f52000-06-08 13:36:40 +0000273** The following global variables are used for testing and debugging
drhfaa57ac2004-06-09 14:01:51 +0000274** only. They only work if SQLITE_DEBUG is defined.
drh6e142f52000-06-08 13:36:40 +0000275*/
danielk19772c336542005-01-13 02:14:23 +0000276#ifdef SQLITE_MEMDEBUG
drh46934232004-11-20 19:18:00 +0000277extern int sqlite3_nMalloc; /* Number of sqliteMalloc() calls */
278extern int sqlite3_nFree; /* Number of sqliteFree() calls */
279extern int sqlite3_iMallocFail; /* Fail sqliteMalloc() after this many calls */
280extern int sqlite3_iMallocReset; /* Set iMallocFail to this when it reaches 0 */
drh6e142f52000-06-08 13:36:40 +0000281#endif
282
283/*
drh75897232000-05-29 14:26:00 +0000284** Name of the master database table. The master database table
285** is a special table that holds the names and attributes of all
286** user tables and indices.
287*/
drhe0bc4042002-06-25 01:09:11 +0000288#define MASTER_NAME "sqlite_master"
289#define TEMP_MASTER_NAME "sqlite_temp_master"
drh75897232000-05-29 14:26:00 +0000290
291/*
danielk19778e150812004-05-10 01:17:37 +0000292** The root-page of the master database table.
293*/
294#define MASTER_ROOT 1
295
296/*
drhed6c8672003-01-12 18:02:16 +0000297** The name of the schema table.
298*/
danielk197753c0f742005-03-29 03:10:59 +0000299#define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
drhed6c8672003-01-12 18:02:16 +0000300
301/*
drh75897232000-05-29 14:26:00 +0000302** A convenience macro that returns the number of elements in
303** an array.
304*/
305#define ArraySize(X) (sizeof(X)/sizeof(X[0]))
306
307/*
308** Forward references to structures
309*/
drh13449892005-09-07 21:22:45 +0000310typedef struct AggInfo AggInfo;
drhfe05af82005-07-21 03:14:59 +0000311typedef struct AuthContext AuthContext;
312typedef struct CollSeq CollSeq;
drh7020f652000-06-03 18:06:52 +0000313typedef struct Column Column;
drhfe05af82005-07-21 03:14:59 +0000314typedef struct Db Db;
drh75897232000-05-29 14:26:00 +0000315typedef struct Expr Expr;
316typedef struct ExprList ExprList;
drhc2eef3b2002-08-31 18:53:06 +0000317typedef struct FKey FKey;
drhfe05af82005-07-21 03:14:59 +0000318typedef struct FuncDef FuncDef;
319typedef struct IdList IdList;
320typedef struct Index Index;
danielk19778d059842004-05-12 11:24:02 +0000321typedef struct KeyClass KeyClass;
drhd3d39e92004-05-20 22:16:29 +0000322typedef struct KeyInfo KeyInfo;
drh626a8792005-01-17 22:08:19 +0000323typedef struct NameContext NameContext;
drhfe05af82005-07-21 03:14:59 +0000324typedef struct Parse Parse;
325typedef struct Select Select;
326typedef struct SrcList SrcList;
327typedef struct Table Table;
328typedef struct Token Token;
329typedef struct TriggerStack TriggerStack;
330typedef struct TriggerStep TriggerStep;
331typedef struct Trigger Trigger;
drhfe05af82005-07-21 03:14:59 +0000332typedef struct WhereInfo WhereInfo;
333typedef struct WhereLevel WhereLevel;
drhd3d39e92004-05-20 22:16:29 +0000334
drh001bbcb2003-03-19 03:14:00 +0000335/*
336** Each database file to be accessed by the system is an instance
337** of the following structure. There are normally two of these structures
338** in the sqlite.aDb[] array. aDb[0] is the main database file and
drha69d9162003-04-17 22:57:53 +0000339** aDb[1] is the database file used to hold temporary tables. Additional
340** databases may be attached.
drh001bbcb2003-03-19 03:14:00 +0000341*/
342struct Db {
343 char *zName; /* Name of this database */
344 Btree *pBt; /* The B*Tree structure for this database file */
345 int schema_cookie; /* Database schema version number for this file */
drhd24cc422003-03-27 12:51:24 +0000346 Hash tblHash; /* All tables indexed by name */
347 Hash idxHash; /* All (named) indices indexed by name */
348 Hash trigHash; /* All triggers indexed by name */
349 Hash aFKey; /* Foreign keys indexed by to-table */
drhd24cc422003-03-27 12:51:24 +0000350 u16 flags; /* Flags associated with this database */
drh90f5ecb2004-07-22 01:19:35 +0000351 u8 inTrans; /* 0: not writable. 1: Transaction. 2: Checkpoint */
danielk197791cf71b2004-06-26 06:37:06 +0000352 u8 safety_level; /* How aggressive at synching data to disk */
353 int cache_size; /* Number of pages to use in the cache */
drh4794f732004-11-05 17:17:50 +0000354 Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */
355 void *pAux; /* Auxiliary data. Usually NULL */
drh4d189ca2004-02-12 18:46:38 +0000356 void (*xFreeAux)(void*); /* Routine to free pAux */
drh001bbcb2003-03-19 03:14:00 +0000357};
drh75897232000-05-29 14:26:00 +0000358
359/*
drh8bf8dc92003-05-17 17:35:10 +0000360** These macros can be used to test, set, or clear bits in the
361** Db.flags field.
362*/
363#define DbHasProperty(D,I,P) (((D)->aDb[I].flags&(P))==(P))
364#define DbHasAnyProperty(D,I,P) (((D)->aDb[I].flags&(P))!=0)
365#define DbSetProperty(D,I,P) (D)->aDb[I].flags|=(P)
366#define DbClearProperty(D,I,P) (D)->aDb[I].flags&=~(P)
367
368/*
369** Allowed values for the DB.flags field.
370**
drh8bf8dc92003-05-17 17:35:10 +0000371** The DB_SchemaLoaded flag is set after the database schema has been
372** read into internal hash tables.
373**
374** DB_UnresetViews means that one or more views have column names that
375** have been filled out. If the schema changes, these column names might
376** changes and so the view will need to be reset.
377*/
drh124b27e2004-06-19 16:06:10 +0000378#define DB_SchemaLoaded 0x0001 /* The schema has been loaded */
379#define DB_UnresetViews 0x0002 /* Some views have defined column names */
drh8bf8dc92003-05-17 17:35:10 +0000380
danielk1977dc8453f2004-06-12 00:42:34 +0000381#define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
drh8bf8dc92003-05-17 17:35:10 +0000382
383/*
drhc9b84a12002-06-20 11:36:48 +0000384** Each database is an instance of the following structure.
385**
rdcb0c374f2004-02-20 22:53:38 +0000386** The sqlite.lastRowid records the last insert rowid generated by an
387** insert statement. Inserts on views do not affect its value. Each
388** trigger has its own context, so that lastRowid can be updated inside
389** triggers as usual. The previous value will be restored once the trigger
390** exits. Upon entering a before or instead of trigger, lastRowid is no
391** longer (since after version 2.8.12) reset to -1.
392**
393** The sqlite.nChange does not count changes within triggers and keeps no
danielk19776f8a5032004-05-10 10:34:51 +0000394** context. It is reset at start of sqlite3_exec.
rdcb0c374f2004-02-20 22:53:38 +0000395** The sqlite.lsChange represents the number of changes made by the last
396** insert, update, or delete statement. It remains constant throughout the
397** length of a statement and is then updated by OP_SetCounts. It keeps a
398** context stack just like lastRowid so that the count of changes
399** within a trigger is not seen outside the trigger. Changes to views do not
400** affect the value of lsChange.
401** The sqlite.csChange keeps track of the number of current changes (since
402** the last statement) and is used to update sqlite_lsChange.
danielk19776622cce2004-05-20 11:00:52 +0000403**
404** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
405** store the most recent error code and, if applicable, string. The
406** internal function sqlite3Error() is used to set these variables
407** consistently.
drh75897232000-05-29 14:26:00 +0000408*/
drh9bb575f2004-09-06 17:24:11 +0000409struct sqlite3 {
drh001bbcb2003-03-19 03:14:00 +0000410 int nDb; /* Number of backends currently in use */
411 Db *aDb; /* All backends */
drh5e00f6c2001-09-13 13:46:56 +0000412 int flags; /* Miscellanous flags. See below */
drhfcd35c72005-05-21 02:48:08 +0000413 int errCode; /* Most recent error code (SQLITE_*) */
414 u8 enc; /* Text encoding for this database. */
415 u8 autoCommit; /* The auto-commit flag. */
drh973b6e32003-02-12 14:09:42 +0000416 u8 file_format; /* What file format version is this database? */
drh90f5ecb2004-07-22 01:19:35 +0000417 u8 temp_store; /* 1: file 2: memory 0: default */
drh5e00f6c2001-09-13 13:46:56 +0000418 int nTable; /* Number of tables in the database */
drhd3d39e92004-05-20 22:16:29 +0000419 CollSeq *pDfltColl; /* The default collating sequence (BINARY) */
drhf328bc82004-05-10 23:29:49 +0000420 i64 lastRowid; /* ROWID of most recent insert (see above) */
421 i64 priorNewRowid; /* Last randomly generated ROWID */
drh247be432002-05-10 05:44:55 +0000422 int magic; /* Magic number for detect library misuse */
danielk1977b28af712004-06-21 06:50:26 +0000423 int nChange; /* Value returned by sqlite3_changes() */
424 int nTotalChange; /* Value returned by sqlite3_total_changes() */
425 struct sqlite3InitInfo { /* Information used during initialization */
426 int iDb; /* When back is being initialized */
427 int newTnum; /* Rootpage of table being initialized */
428 u8 busy; /* TRUE if currently initializing */
drh1d85d932004-02-14 23:05:52 +0000429 } init;
drh326dce72003-01-29 14:06:07 +0000430 struct Vdbe *pVdbe; /* List of active virtual machines */
danielk19771d850a72004-05-31 08:26:49 +0000431 int activeVdbeCnt; /* Number of vdbes currently executing */
drh19e2d372005-08-29 23:00:03 +0000432 void (*xTrace)(void*,const char*); /* Trace function */
433 void *pTraceArg; /* Argument to the trace function */
434 void (*xProfile)(void*,const char*,u64); /* Profiling function */
435 void *pProfileArg; /* Argument to profile function */
drhfcd35c72005-05-21 02:48:08 +0000436 void *pCommitArg; /* Argument to xCommitCallback() */
437 int (*xCommitCallback)(void*);/* Invoked at every commit. */
438 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
439 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
440 void *pCollNeededArg;
441 sqlite3_value *pValue; /* Value used for transient conversions */
442 sqlite3_value *pErr; /* Most recent error message */
443 char *zErrMsg; /* Most recent error message (UTF-8 encoded) */
444 char *zErrMsg16; /* Most recent error message (UTF-16 encoded) */
drhed6c8672003-01-12 18:02:16 +0000445#ifndef SQLITE_OMIT_AUTHORIZATION
drhe22a3342003-04-22 20:30:37 +0000446 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
447 /* Access authorization function */
drhed6c8672003-01-12 18:02:16 +0000448 void *pAuthArg; /* 1st argument to the access auth function */
449#endif
danielk1977348bb5d2003-10-18 09:37:26 +0000450#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
451 int (*xProgress)(void *); /* The progress callback */
452 void *pProgressArg; /* Argument to the progress callback */
453 int nProgressOps; /* Number of opcodes for progress callback */
454#endif
danielk19776b456a22005-03-21 04:04:02 +0000455#ifndef SQLITE_OMIT_GLOBALRECOVER
456 sqlite3 *pNext; /* Linked list of open db handles. */
457#endif
drhfcd35c72005-05-21 02:48:08 +0000458 Hash aFunc; /* All functions that can be in SQL exprs */
459 Hash aCollSeq; /* All collating sequences */
460 BusyHandler busyHandler; /* Busy callback */
drh97903fe2005-05-24 20:19:57 +0000461 int busyTimeout; /* Busy handler timeout, in msec */
drhfcd35c72005-05-21 02:48:08 +0000462 Db aDbStatic[2]; /* Static space for the 2 default backends */
danielk19777e900ab2005-05-23 04:51:01 +0000463#ifdef SQLITE_SSE
464 sqlite3_stmt *pFetch; /* Used by SSE to fetch stored statements */
465#endif
drh75897232000-05-29 14:26:00 +0000466};
467
468/*
drh8bf8dc92003-05-17 17:35:10 +0000469** Possible values for the sqlite.flags and or Db.flags fields.
470**
471** On sqlite.flags, the SQLITE_InTrans value means that we have
472** executed a BEGIN. On Db.flags, SQLITE_InTrans means a statement
473** transaction is active on that particular database file.
drh75897232000-05-29 14:26:00 +0000474*/
drh5e00f6c2001-09-13 13:46:56 +0000475#define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */
476#define SQLITE_Initialized 0x00000002 /* True after initialization */
477#define SQLITE_Interrupt 0x00000004 /* Cancel current operation */
478#define SQLITE_InTrans 0x00000008 /* True if in a transaction */
479#define SQLITE_InternChanges 0x00000010 /* Uncommitted Hash table changes */
drh382c0242001-10-06 16:33:02 +0000480#define SQLITE_FullColNames 0x00000020 /* Show full column names on SELECT */
drhfcabd462004-02-20 14:50:58 +0000481#define SQLITE_ShortColNames 0x00000040 /* Show short columns names */
482#define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */
drh1bee3d72001-10-15 00:44:35 +0000483 /* DELETE, or UPDATE and return */
484 /* the count using a callback. */
drhfcabd462004-02-20 14:50:58 +0000485#define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */
drh6a535342001-10-19 16:44:56 +0000486 /* result set is empty */
drh35d4c2f2004-06-10 01:30:59 +0000487#define SQLITE_SqlTrace 0x00000200 /* Debug print SQL as it executes */
488#define SQLITE_VdbeListing 0x00000400 /* Debug listings of VDBE programs */
drhf4040832004-10-22 20:29:21 +0000489#define SQLITE_WriteSchema 0x00000800 /* OK to update SQLITE_MASTER */
drh7bec5052005-02-06 02:45:41 +0000490#define SQLITE_NoReadlock 0x00001000 /* Readlocks are omitted when
491 ** accessing read-only databases */
drh58b95762000-06-02 01:17:37 +0000492
493/*
drh247be432002-05-10 05:44:55 +0000494** Possible values for the sqlite.magic field.
495** The numbers are obtained at random and have no special meaning, other
496** than being distinct from one another.
497*/
498#define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */
499#define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */
500#define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */
501#define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */
502
503/*
drh0bce8352002-02-28 00:41:10 +0000504** Each SQL function is defined by an instance of the following
505** structure. A pointer to this structure is stored in the sqlite.aFunc
drh8e0a2f92002-02-23 23:45:45 +0000506** hash table. When multiple functions have the same name, the hash table
507** points to a linked list of these structures.
drh28037572000-08-02 13:47:41 +0000508*/
drh0bce8352002-02-28 00:41:10 +0000509struct FuncDef {
drh55ef4d92005-08-14 01:20:37 +0000510 i16 nArg; /* Number of arguments. -1 means unlimited */
danielk1977d8123362004-06-12 09:25:12 +0000511 u8 iPrefEnc; /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
drh55ef4d92005-08-14 01:20:37 +0000512 u8 needCollSeq; /* True if sqlite3GetFuncCollSeq() might be called */
513 u8 flags; /* Some combination of SQLITE_FUNC_* */
drhf9b596e2004-05-26 16:54:42 +0000514 void *pUserData; /* User data parameter */
515 FuncDef *pNext; /* Next function with same name */
516 void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
517 void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
518 void (*xFinalize)(sqlite3_context*); /* Aggregate finializer */
drh55ef4d92005-08-14 01:20:37 +0000519 char zName[1]; /* SQL name of the function. MUST BE LAST */
drh8e0a2f92002-02-23 23:45:45 +0000520};
drh28037572000-08-02 13:47:41 +0000521
522/*
drh55ef4d92005-08-14 01:20:37 +0000523** Possible values for FuncDef.flags
524*/
drhd64fe2f2005-08-28 17:00:23 +0000525#define SQLITE_FUNC_LIKE 0x01 /* Candidate for the LIKE optimization */
526#define SQLITE_FUNC_CASE 0x02 /* Case-sensitive LIKE-type function */
drh55ef4d92005-08-14 01:20:37 +0000527
528/*
drh967e8b72000-06-21 13:59:10 +0000529** information about each column of an SQL table is held in an instance
drh7020f652000-06-03 18:06:52 +0000530** of this structure.
531*/
532struct Column {
drh967e8b72000-06-21 13:59:10 +0000533 char *zName; /* Name of this column */
danielk19777977a172004-11-09 12:44:37 +0000534 Expr *pDflt; /* Default value of this column */
drh382c0242001-10-06 16:33:02 +0000535 char *zType; /* Data type for this column */
drha9fd84b2004-05-18 23:21:35 +0000536 CollSeq *pColl; /* Collating sequence. If NULL, use the default */
drh4a324312001-12-21 14:30:42 +0000537 u8 notNull; /* True if there is a NOT NULL constraint */
drh78100cc2003-08-23 22:40:53 +0000538 u8 isPrimKey; /* True if this column is part of the PRIMARY KEY */
danielk1977a37cdde2004-05-16 11:15:36 +0000539 char affinity; /* One of the SQLITE_AFF_... values */
drh7020f652000-06-03 18:06:52 +0000540};
541
542/*
drha9fd84b2004-05-18 23:21:35 +0000543** A "Collating Sequence" is defined by an instance of the following
danielk19770202b292004-06-09 09:55:16 +0000544** structure. Conceptually, a collating sequence consists of a name and
545** a comparison routine that defines the order of that sequence.
drha9fd84b2004-05-18 23:21:35 +0000546**
danielk19770202b292004-06-09 09:55:16 +0000547** There may two seperate implementations of the collation function, one
548** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
549** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
550** native byte order. When a collation sequence is invoked, SQLite selects
551** the version that will require the least expensive encoding
552** transalations, if any.
553**
554** The CollSeq.pUser member variable is an extra parameter that passed in
555** as the first argument to the UTF-8 comparison function, xCmp.
556** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
557** xCmp16.
558**
559** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
560** collating sequence is undefined. Indices built on an undefined
561** collating sequence may not be read or written.
drha9fd84b2004-05-18 23:21:35 +0000562*/
563struct CollSeq {
danielk19770202b292004-06-09 09:55:16 +0000564 char *zName; /* Name of the collating sequence, UTF-8 encoded */
danielk1977466be562004-06-10 02:16:01 +0000565 u8 enc; /* Text encoding handled by xCmp() */
drhd64fe2f2005-08-28 17:00:23 +0000566 u8 type; /* One of the SQLITE_COLL_... values below */
drha9fd84b2004-05-18 23:21:35 +0000567 void *pUser; /* First argument to xCmp() */
danielk19770202b292004-06-09 09:55:16 +0000568 int (*xCmp)(void*,int, const void*, int, const void*);
drha9fd84b2004-05-18 23:21:35 +0000569};
570
571/*
drhd64fe2f2005-08-28 17:00:23 +0000572** Allowed values of CollSeq flags:
573*/
574#define SQLITE_COLL_BINARY 1 /* The default memcmp() collating sequence */
575#define SQLITE_COLL_NOCASE 2 /* The built-in NOCASE collating sequence */
576#define SQLITE_COLL_REVERSE 3 /* The built-in REVERSE collating sequence */
577#define SQLITE_COLL_USER 0 /* Any other user-defined collating sequence */
578
579/*
drhd3d39e92004-05-20 22:16:29 +0000580** A sort order can be either ASC or DESC.
drh8e2ca022002-06-17 17:07:19 +0000581*/
drh8e2ca022002-06-17 17:07:19 +0000582#define SQLITE_SO_ASC 0 /* Sort in ascending order */
drhd3d39e92004-05-20 22:16:29 +0000583#define SQLITE_SO_DESC 1 /* Sort in ascending order */
drh8e2ca022002-06-17 17:07:19 +0000584
585/*
danielk1977a37cdde2004-05-16 11:15:36 +0000586** Column affinity types.
587*/
danielk1977a37cdde2004-05-16 11:15:36 +0000588#define SQLITE_AFF_NUMERIC 'n'
drh8df447f2005-11-01 15:48:24 +0000589#define SQLITE_AFF_INTEGER 'i' /* Used for CAST operators only */
danielk1977a37cdde2004-05-16 11:15:36 +0000590#define SQLITE_AFF_TEXT 't'
591#define SQLITE_AFF_NONE 'o'
592
593
594/*
drh22f70c32002-02-18 01:17:00 +0000595** Each SQL table is represented in memory by an instance of the
596** following structure.
597**
drhd24cc422003-03-27 12:51:24 +0000598** Table.zName is the name of the table. The case of the original
drh22f70c32002-02-18 01:17:00 +0000599** CREATE TABLE statement is stored, but case is not significant for
600** comparisons.
601**
drhd24cc422003-03-27 12:51:24 +0000602** Table.nCol is the number of columns in this table. Table.aCol is a
drh22f70c32002-02-18 01:17:00 +0000603** pointer to an array of Column structures, one for each column.
604**
drhd24cc422003-03-27 12:51:24 +0000605** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
606** the column that is that key. Otherwise Table.iPKey is negative. Note
drh22f70c32002-02-18 01:17:00 +0000607** that the datatype of the PRIMARY KEY must be INTEGER for this field to
608** be set. An INTEGER PRIMARY KEY is used as the rowid for each row of
609** the table. If a table has no INTEGER PRIMARY KEY, then a random rowid
drhd24cc422003-03-27 12:51:24 +0000610** is generated for each row of the table. Table.hasPrimKey is true if
drh22f70c32002-02-18 01:17:00 +0000611** the table has any PRIMARY KEY, INTEGER or otherwise.
612**
drhd24cc422003-03-27 12:51:24 +0000613** Table.tnum is the page number for the root BTree page of the table in the
614** database file. If Table.iDb is the index of the database table backend
615** in sqlite.aDb[]. 0 is for the main database and 1 is for the file that
616** holds temporary tables and indices. If Table.isTransient
drh22f70c32002-02-18 01:17:00 +0000617** is true, then the table is stored in a file that is automatically deleted
drhd24cc422003-03-27 12:51:24 +0000618** when the VDBE cursor to the table is closed. In this case Table.tnum
drh22f70c32002-02-18 01:17:00 +0000619** refers VDBE cursor number that holds the table open, not to the root
620** page number. Transient tables are used to hold the results of a
621** sub-query that appears instead of a real table name in the FROM clause
622** of a SELECT statement.
drh75897232000-05-29 14:26:00 +0000623*/
624struct Table {
drh967e8b72000-06-21 13:59:10 +0000625 char *zName; /* Name of the table */
drh967e8b72000-06-21 13:59:10 +0000626 int nCol; /* Number of columns in this table */
627 Column *aCol; /* Information about each column */
drhc8392582001-12-31 02:48:51 +0000628 int iPKey; /* If not less then 0, use aCol[iPKey] as the primary key */
drh967e8b72000-06-21 13:59:10 +0000629 Index *pIndex; /* List of SQL indexes on this table. */
drh22f70c32002-02-18 01:17:00 +0000630 int tnum; /* Root BTree node for this table (see note above) */
drha76b5df2002-02-23 02:32:10 +0000631 Select *pSelect; /* NULL for tables. Points to definition if a view. */
drh717e6402001-09-27 03:22:32 +0000632 u8 readOnly; /* True if this table should not be written by the user */
drhd24cc422003-03-27 12:51:24 +0000633 u8 iDb; /* Index into sqlite.aDb[] of the backend for this table */
drh22f70c32002-02-18 01:17:00 +0000634 u8 isTransient; /* True if automatically deleted when VDBE finishes */
drh4a324312001-12-21 14:30:42 +0000635 u8 hasPrimKey; /* True if there exists a primary key */
drh9cfcf5d2002-01-29 18:41:24 +0000636 u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */
drh205f48e2004-11-05 00:43:11 +0000637 u8 autoInc; /* True if the integer primary key is autoincrement */
drhed8a3bb2005-06-06 21:19:56 +0000638 int nRef; /* Number of pointers to this Table */
danielk1977c3f9bad2002-05-15 08:30:12 +0000639 Trigger *pTrigger; /* List of SQL triggers on this table */
drhc2eef3b2002-08-31 18:53:06 +0000640 FKey *pFKey; /* Linked list of all foreign keys in this table */
danielk19773d1bfea2004-05-14 11:00:53 +0000641 char *zColAff; /* String defining the affinity of each column */
drhffe07b22005-11-03 00:41:17 +0000642#ifndef SQLITE_OMIT_CHECK
643 Expr *pCheck; /* The AND of all CHECK constraints */
644#endif
danielk197719a8e7e2005-03-17 05:03:38 +0000645#ifndef SQLITE_OMIT_ALTERTABLE
646 int addColOffset; /* Offset in CREATE TABLE statement to add a new column */
647#endif
drh75897232000-05-29 14:26:00 +0000648};
649
650/*
drhc2eef3b2002-08-31 18:53:06 +0000651** Each foreign key constraint is an instance of the following structure.
652**
653** A foreign key is associated with two tables. The "from" table is
654** the table that contains the REFERENCES clause that creates the foreign
655** key. The "to" table is the table that is named in the REFERENCES clause.
656** Consider this example:
657**
658** CREATE TABLE ex1(
659** a INTEGER PRIMARY KEY,
660** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
661** );
662**
663** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
664**
665** Each REFERENCES clause generates an instance of the following structure
666** which is attached to the from-table. The to-table need not exist when
667** the from-table is created. The existance of the to-table is not checked
668** until an attempt is made to insert data into the from-table.
669**
drhea1ba172003-04-20 00:00:23 +0000670** The sqlite.aFKey hash table stores pointers to this structure
drhc2eef3b2002-08-31 18:53:06 +0000671** given the name of a to-table. For each to-table, all foreign keys
672** associated with that table are on a linked list using the FKey.pNextTo
673** field.
674*/
675struct FKey {
676 Table *pFrom; /* The table that constains the REFERENCES clause */
677 FKey *pNextFrom; /* Next foreign key in pFrom */
678 char *zTo; /* Name of table that the key points to */
679 FKey *pNextTo; /* Next foreign key that points to zTo */
680 int nCol; /* Number of columns in this key */
681 struct sColMap { /* Mapping of columns in pFrom to columns in zTo */
682 int iFrom; /* Index of column in pFrom */
683 char *zCol; /* Name of column in zTo. If 0 use PRIMARY KEY */
684 } *aCol; /* One entry for each of nCol column s */
685 u8 isDeferred; /* True if constraint checking is deferred till COMMIT */
686 u8 updateConf; /* How to resolve conflicts that occur on UPDATE */
687 u8 deleteConf; /* How to resolve conflicts that occur on DELETE */
688 u8 insertConf; /* How to resolve conflicts that occur on INSERT */
689};
690
691/*
692** SQLite supports many different ways to resolve a contraint
drh22f70c32002-02-18 01:17:00 +0000693** error. ROLLBACK processing means that a constraint violation
drh0bd1f4e2002-06-06 18:54:39 +0000694** causes the operation in process to fail and for the current transaction
drh1c928532002-01-31 15:54:21 +0000695** to be rolled back. ABORT processing means the operation in process
696** fails and any prior changes from that one operation are backed out,
697** but the transaction is not rolled back. FAIL processing means that
698** the operation in progress stops and returns an error code. But prior
699** changes due to the same operation are not backed out and no rollback
700** occurs. IGNORE means that the particular row that caused the constraint
701** error is not inserted or updated. Processing continues and no error
702** is returned. REPLACE means that preexisting database rows that caused
703** a UNIQUE constraint violation are removed so that the new insert or
704** update can proceed. Processing continues and no error is reported.
drhc2eef3b2002-08-31 18:53:06 +0000705**
706** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
707** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
708** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign
709** key is set to NULL. CASCADE means that a DELETE or UPDATE of the
710** referenced table row is propagated into the row that holds the
711** foreign key.
drh1c928532002-01-31 15:54:21 +0000712**
drh968af522003-02-11 14:55:40 +0000713** The following symbolic values are used to record which type
drh1c928532002-01-31 15:54:21 +0000714** of action to take.
drh9cfcf5d2002-01-29 18:41:24 +0000715*/
drh1c928532002-01-31 15:54:21 +0000716#define OE_None 0 /* There is no constraint to check */
717#define OE_Rollback 1 /* Fail the operation and rollback the transaction */
718#define OE_Abort 2 /* Back out changes but do no rollback transaction */
719#define OE_Fail 3 /* Stop the operation but leave all prior changes */
720#define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */
721#define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */
drhc2eef3b2002-08-31 18:53:06 +0000722
723#define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
724#define OE_SetNull 7 /* Set the foreign key value to NULL */
725#define OE_SetDflt 8 /* Set the foreign key value to its default */
726#define OE_Cascade 9 /* Cascade the changes */
727
728#define OE_Default 99 /* Do whatever the default action is */
drh9cfcf5d2002-01-29 18:41:24 +0000729
drhd3d39e92004-05-20 22:16:29 +0000730
731/*
732** An instance of the following structure is passed as the first
733** argument to sqlite3VdbeKeyCompare and is used to control the
734** comparison of the two index keys.
735**
736** If the KeyInfo.incrKey value is true and the comparison would
drh7e627792005-04-29 02:10:00 +0000737** otherwise be equal, then return a result as if the second key
738** were larger.
drhd3d39e92004-05-20 22:16:29 +0000739*/
740struct KeyInfo {
danielk1977b1bc9532004-05-22 03:05:33 +0000741 u8 enc; /* Text encoding - one of the TEXT_Utf* values */
drhd3d39e92004-05-20 22:16:29 +0000742 u8 incrKey; /* Increase 2nd key by epsilon before comparison */
743 int nField; /* Number of entries in aColl[] */
drhffbc3082004-05-21 01:29:06 +0000744 u8 *aSortOrder; /* If defined an aSortOrder[i] is true, sort DESC */
drhd3d39e92004-05-20 22:16:29 +0000745 CollSeq *aColl[1]; /* Collating sequence for each term of the key */
746};
747
drh9cfcf5d2002-01-29 18:41:24 +0000748/*
drh66b89c82000-11-28 20:47:17 +0000749** Each SQL index is represented in memory by an
drh75897232000-05-29 14:26:00 +0000750** instance of the following structure.
drh967e8b72000-06-21 13:59:10 +0000751**
752** The columns of the table that are to be indexed are described
753** by the aiColumn[] field of this structure. For example, suppose
754** we have the following table and index:
755**
756** CREATE TABLE Ex1(c1 int, c2 int, c3 text);
757** CREATE INDEX Ex2 ON Ex1(c3,c1);
758**
759** In the Table structure describing Ex1, nCol==3 because there are
760** three columns in the table. In the Index structure describing
761** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
762** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the
763** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
764** The second column to be indexed (c1) has an index of 0 in
765** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
drhea1ba172003-04-20 00:00:23 +0000766**
767** The Index.onError field determines whether or not the indexed columns
768** must be unique and what to do if they are not. When Index.onError=OE_None,
769** it means this is not a unique index. Otherwise it is a unique index
770** and the value of Index.onError indicate the which conflict resolution
771** algorithm to employ whenever an attempt is made to insert a non-unique
772** element.
drh75897232000-05-29 14:26:00 +0000773*/
774struct Index {
drh967e8b72000-06-21 13:59:10 +0000775 char *zName; /* Name of this index */
drh967e8b72000-06-21 13:59:10 +0000776 int nColumn; /* Number of columns in the table used by this index */
777 int *aiColumn; /* Which columns are used by this index. 1st is 0 */
drh8b3d9902005-08-19 00:14:42 +0000778 unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
drh967e8b72000-06-21 13:59:10 +0000779 Table *pTable; /* The SQL table being indexed */
drhbe0072d2001-09-13 14:46:09 +0000780 int tnum; /* Page containing root of this index in database file */
drh9cfcf5d2002-01-29 18:41:24 +0000781 u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
drh485b39b2002-07-13 03:11:52 +0000782 u8 autoIndex; /* True if is automatically created (ex: by UNIQUE) */
drhd24cc422003-03-27 12:51:24 +0000783 u8 iDb; /* Index in sqlite.aDb[] of where this index is stored */
danielk1977a37cdde2004-05-16 11:15:36 +0000784 char *zColAff; /* String defining the affinity of each column */
drh967e8b72000-06-21 13:59:10 +0000785 Index *pNext; /* The next index associated with the same table */
drhd3d39e92004-05-20 22:16:29 +0000786 KeyInfo keyInfo; /* Info on how to order keys. MUST BE LAST */
drh75897232000-05-29 14:26:00 +0000787};
788
789/*
790** Each token coming out of the lexer is an instance of
drh4b59ab52002-08-24 18:24:51 +0000791** this structure. Tokens are also used as part of an expression.
drh4efc4752004-01-16 15:55:37 +0000792**
793** Note if Token.z==0 then Token.dyn and Token.n are undefined and
794** may contain random values. Do not make any assuptions about Token.dyn
795** and Token.n when Token.z==0.
drh75897232000-05-29 14:26:00 +0000796*/
797struct Token {
drh4c755c02004-08-08 20:22:17 +0000798 const unsigned char *z; /* Text of the token. Not NULL-terminated! */
799 unsigned dyn : 1; /* True for malloced memory, false for static */
800 unsigned n : 31; /* Number of characters in this token */
drh75897232000-05-29 14:26:00 +0000801};
802
803/*
drh13449892005-09-07 21:22:45 +0000804** An instance of this structure contains information needed to generate
805** code for a SELECT that contains aggregate functions.
806**
807** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
808** pointer to this structure. The Expr.iColumn field is the index in
809** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
810** code for that node.
811**
812** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
813** original Select structure that describes the SELECT statement. These
814** fields do not need to be freed when deallocating the AggInfo structure.
815*/
816struct AggInfo {
817 u8 directMode; /* Direct rendering mode means take data directly
818 ** from source tables rather than from accumulators */
819 u8 useSortingIdx; /* In direct mode, reference the sorting index rather
820 ** than the source table */
821 int sortingIdx; /* Cursor number of the sorting index */
822 ExprList *pGroupBy; /* The group by clause */
823 int nSortingColumn; /* Number of columns in the sorting index */
824 struct AggInfo_col { /* For each column used in source tables */
825 int iTable; /* Cursor number of the source table */
826 int iColumn; /* Column number within the source table */
827 int iSorterColumn; /* Column number in the sorting index */
828 int iMem; /* Memory location that acts as accumulator */
drh5774b802005-09-07 22:48:16 +0000829 Expr *pExpr; /* The original expression */
drh13449892005-09-07 21:22:45 +0000830 } *aCol;
831 int nColumn; /* Number of used entries in aCol[] */
832 int nColumnAlloc; /* Number of slots allocated for aCol[] */
833 int nAccumulator; /* Number of columns that show through to the output.
834 ** Additional columns are used only as parameters to
835 ** aggregate functions */
836 struct AggInfo_func { /* For each aggregate function */
837 Expr *pExpr; /* Expression encoding the function */
838 FuncDef *pFunc; /* The aggregate function implementation */
839 int iMem; /* Memory location that acts as accumulator */
drhfd357972005-09-09 01:33:19 +0000840 int iDistinct; /* Virtual table used to enforce DISTINCT */
drh13449892005-09-07 21:22:45 +0000841 } *aFunc;
842 int nFunc; /* Number of entries in aFunc[] */
843 int nFuncAlloc; /* Number of slots allocated for aFunc[] */
844};
845
846/*
drh75897232000-05-29 14:26:00 +0000847** Each node of an expression in the parse tree is an instance
drh22f70c32002-02-18 01:17:00 +0000848** of this structure.
849**
850** Expr.op is the opcode. The integer parser token codes are reused
851** as opcodes here. For example, the parser defines TK_GE to be an integer
852** code representing the ">=" operator. This same integer code is reused
853** to represent the greater-than-or-equal-to operator in the expression
854** tree.
855**
856** Expr.pRight and Expr.pLeft are subexpressions. Expr.pList is a list
857** of argument if the expression is a function.
858**
drh4b59ab52002-08-24 18:24:51 +0000859** Expr.token is the operator token for this node. For some expressions
860** that have subexpressions, Expr.token can be the complete text that gave
861** rise to the Expr. In the latter case, the token is marked as being
862** a compound token.
drh22f70c32002-02-18 01:17:00 +0000863**
864** An expression of the form ID or ID.ID refers to a column in a table.
865** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
866** the integer cursor number of a VDBE cursor pointing to that table and
867** Expr.iColumn is the column number for the specific column. If the
868** expression is used as a result in an aggregate SELECT, then the
869** value is also stored in the Expr.iAgg column in the aggregate so that
870** it can be accessed after all aggregates are computed.
871**
872** If the expression is a function, the Expr.iTable is an integer code
drh7c972de2003-09-06 22:18:07 +0000873** representing which function. If the expression is an unbound variable
874** marker (a question mark character '?' in the original SQL) then the
875** Expr.iTable holds the index number for that variable.
drh22f70c32002-02-18 01:17:00 +0000876**
drh1398ad32005-01-19 23:24:50 +0000877** If the expression is a subquery then Expr.iColumn holds an integer
878** register number containing the result of the subquery. If the
879** subquery gives a constant result, then iTable is -1. If the subquery
880** gives a different answer at different times during statement processing
881** then iTable is the address of a subroutine that computes the subquery.
882**
drh22f70c32002-02-18 01:17:00 +0000883** The Expr.pSelect field points to a SELECT statement. The SELECT might
884** be the right operand of an IN operator. Or, if a scalar SELECT appears
885** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
886** operand.
danielk1977aee18ef2005-03-09 12:26:50 +0000887**
888** If the Expr is of type OP_Column, and the table it is selecting from
889** is a disk table or the "old.*" pseudo-table, then pTab points to the
890** corresponding table definition.
drh75897232000-05-29 14:26:00 +0000891*/
892struct Expr {
drh1cc093c2002-06-24 22:01:57 +0000893 u8 op; /* Operation performed by this node */
drha9fd84b2004-05-18 23:21:35 +0000894 char affinity; /* The affinity of the column or 0 if not a column */
drhb5a20d32003-04-23 12:25:23 +0000895 u8 iDb; /* Database referenced by this expression */
drhe22a3342003-04-22 20:30:37 +0000896 u8 flags; /* Various flags. See below */
drhf2bc0132004-10-04 13:19:23 +0000897 CollSeq *pColl; /* The collation type of the column or 0 */
drh75897232000-05-29 14:26:00 +0000898 Expr *pLeft, *pRight; /* Left and right subnodes */
drhd99f7062002-06-08 23:25:08 +0000899 ExprList *pList; /* A list of expressions used as function arguments
900 ** or in "<expr> IN (<expr-list)" */
drh75897232000-05-29 14:26:00 +0000901 Token token; /* An operand token */
drh6977fea2002-10-22 23:38:04 +0000902 Token span; /* Complete text of the expression */
drh967e8b72000-06-21 13:59:10 +0000903 int iTable, iColumn; /* When op==TK_COLUMN, then this expr node means the
drh8e2ca022002-06-17 17:07:19 +0000904 ** iColumn-th field of the iTable-th table. */
drh13449892005-09-07 21:22:45 +0000905 AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
906 int iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
drh22d6a532005-09-19 21:05:48 +0000907 int iRightJoinTable; /* If EP_FromJoin, the right table of the join */
drhd99f7062002-06-08 23:25:08 +0000908 Select *pSelect; /* When the expression is a sub-select. Also the
909 ** right side of "<expr> IN (<select>)" */
danielk1977aee18ef2005-03-09 12:26:50 +0000910 Table *pTab; /* Table for OP_Column expressions. */
drh75897232000-05-29 14:26:00 +0000911};
912
913/*
drh1f162302002-10-27 19:35:33 +0000914** The following are the meanings of bits in the Expr.flags field.
915*/
drh392e5972005-07-08 14:14:22 +0000916#define EP_FromJoin 0x01 /* Originated in ON or USING clause of a join */
917#define EP_Agg 0x02 /* Contains one or more aggregate functions */
918#define EP_Resolved 0x04 /* IDs have been resolved to COLUMNs */
919#define EP_Error 0x08 /* Expression contains one or more errors */
drhfd357972005-09-09 01:33:19 +0000920#define EP_Distinct 0x10 /* Aggregate function with DISTINCT keyword */
drh392e5972005-07-08 14:14:22 +0000921#define EP_VarSelect 0x20 /* pSelect is correlated, not constant */
drhd2687b72005-08-12 22:56:09 +0000922#define EP_Dequoted 0x40 /* True if the string has been dequoted */
drh1f162302002-10-27 19:35:33 +0000923
924/*
925** These macros can be used to test, set, or clear bits in the
926** Expr.flags field.
927*/
928#define ExprHasProperty(E,P) (((E)->flags&(P))==(P))
929#define ExprHasAnyProperty(E,P) (((E)->flags&(P))!=0)
930#define ExprSetProperty(E,P) (E)->flags|=(P)
931#define ExprClearProperty(E,P) (E)->flags&=~(P)
932
933/*
drh75897232000-05-29 14:26:00 +0000934** A list of expressions. Each expression may optionally have a
935** name. An expr/name combination can be used in several ways, such
936** as the list of "expr AS ID" fields following a "SELECT" or in the
937** list of "ID = expr" items in an UPDATE. A list of expressions can
drhad3cab52002-05-24 02:04:32 +0000938** also be used as the argument to a function, in which case the a.zName
drh75897232000-05-29 14:26:00 +0000939** field is not used.
940*/
941struct ExprList {
942 int nExpr; /* Number of expressions on the list */
drh4305d102003-07-30 12:34:12 +0000943 int nAlloc; /* Number of entries allocated below */
drh9d2985c2005-09-08 01:58:42 +0000944 int iECursor; /* VDBE Cursor associated with this ExprList */
drh6d4abfb2001-10-22 02:58:08 +0000945 struct ExprList_item {
drh75897232000-05-29 14:26:00 +0000946 Expr *pExpr; /* The list of expressions */
947 char *zName; /* Token associated with this expression */
drh8e2ca022002-06-17 17:07:19 +0000948 u8 sortOrder; /* 1 for DESC or 0 for ASC */
949 u8 isAgg; /* True if this is an aggregate like count(*) */
950 u8 done; /* A flag to indicate when processing is finished */
drh75897232000-05-29 14:26:00 +0000951 } *a; /* One entry for each expression */
952};
953
954/*
drhad3cab52002-05-24 02:04:32 +0000955** An instance of this structure can hold a simple list of identifiers,
956** such as the list "a,b,c" in the following statements:
957**
958** INSERT INTO t(a,b,c) VALUES ...;
959** CREATE INDEX idx ON t(a,b,c);
960** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
961**
962** The IdList.a.idx field is used when the IdList represents the list of
963** column names after a table name in an INSERT statement. In the statement
964**
965** INSERT INTO t(a,b,c) ...
966**
967** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
drh75897232000-05-29 14:26:00 +0000968*/
969struct IdList {
drh6d4abfb2001-10-22 02:58:08 +0000970 struct IdList_item {
drhad3cab52002-05-24 02:04:32 +0000971 char *zName; /* Name of the identifier */
drh967e8b72000-06-21 13:59:10 +0000972 int idx; /* Index in some Table.aCol[] of a column named zName */
drhad3cab52002-05-24 02:04:32 +0000973 } *a;
drh13449892005-09-07 21:22:45 +0000974 int nId; /* Number of identifiers on the list */
975 int nAlloc; /* Number of entries allocated for a[] below */
drhad3cab52002-05-24 02:04:32 +0000976};
977
978/*
drh51669862004-12-18 18:40:26 +0000979** The bitmask datatype defined below is used for various optimizations.
980*/
981typedef unsigned int Bitmask;
982
983/*
drhad3cab52002-05-24 02:04:32 +0000984** The following structure describes the FROM clause of a SELECT statement.
985** Each table or subquery in the FROM clause is a separate element of
986** the SrcList.a[] array.
drhd24cc422003-03-27 12:51:24 +0000987**
988** With the addition of multiple database support, the following structure
989** can also be used to describe a particular table such as the table that
990** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL,
991** such a table must be a simple name: ID. But in SQLite, the table can
992** now be identified by a database name, a dot, then the table name: ID.ID.
drhad3cab52002-05-24 02:04:32 +0000993*/
994struct SrcList {
drh939a16d2004-07-15 13:37:22 +0000995 i16 nSrc; /* Number of tables or subqueries in the FROM clause */
996 i16 nAlloc; /* Number of entries allocated in a[] below */
drhad3cab52002-05-24 02:04:32 +0000997 struct SrcList_item {
drh113088e2003-03-20 01:16:58 +0000998 char *zDatabase; /* Name of database holding this table */
drhad3cab52002-05-24 02:04:32 +0000999 char *zName; /* Name of the table */
1000 char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */
drhdaffd0e2001-04-11 14:28:42 +00001001 Table *pTab; /* An SQL table corresponding to zName */
1002 Select *pSelect; /* A SELECT statement used in place of a table name */
drhfe05af82005-07-21 03:14:59 +00001003 u8 jointype; /* Type of join between this table and the next */
1004 i16 iCursor; /* The VDBE cursor number used to access this table */
drhad3cab52002-05-24 02:04:32 +00001005 Expr *pOn; /* The ON clause of a join */
1006 IdList *pUsing; /* The USING clause of a join */
drh51669862004-12-18 18:40:26 +00001007 Bitmask colUsed; /* Bit N (1<<N) set if column N or pTab is used */
drh113088e2003-03-20 01:16:58 +00001008 } a[1]; /* One entry for each identifier on the list */
drh75897232000-05-29 14:26:00 +00001009};
1010
1011/*
drh01f3f252002-05-24 16:14:15 +00001012** Permitted values of the SrcList.a.jointype field
1013*/
1014#define JT_INNER 0x0001 /* Any kind of inner or cross join */
drh3dec2232005-09-10 15:28:09 +00001015#define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */
1016#define JT_NATURAL 0x0004 /* True for a "natural" join */
1017#define JT_LEFT 0x0008 /* Left outer join */
1018#define JT_RIGHT 0x0010 /* Right outer join */
1019#define JT_OUTER 0x0020 /* The "OUTER" keyword is present */
1020#define JT_ERROR 0x0040 /* unknown or unsupported join type */
drh01f3f252002-05-24 16:14:15 +00001021
1022/*
drh6b563442001-11-07 16:48:26 +00001023** For each nested loop in a WHERE clause implementation, the WhereInfo
1024** structure contains a single instance of this structure. This structure
1025** is intended to be private the the where.c module and should not be
1026** access or modified by other modules.
1027*/
1028struct WhereLevel {
drh29dda4a2005-07-21 18:23:20 +00001029 int iFrom; /* Which entry in the FROM clause */
1030 int flags; /* Flags associated with this level */
drh51147ba2005-07-23 22:59:55 +00001031 int iMem; /* First memory cell used by this level */
drh29dda4a2005-07-21 18:23:20 +00001032 int iLeftJoin; /* Memory cell used to implement LEFT OUTER JOIN */
1033 Index *pIdx; /* Index used. NULL if no index */
1034 int iTabCur; /* The VDBE cursor used to access the table */
1035 int iIdxCur; /* The VDBE cursor used to acesss pIdx */
1036 int brk; /* Jump here to break out of the loop */
1037 int cont; /* Jump here to continue with the next loop cycle */
1038 int top; /* First instruction of interior of the loop */
1039 int op, p1, p2; /* Opcode used to terminate the loop */
drh51147ba2005-07-23 22:59:55 +00001040 int nEq; /* Number of == or IN constraints on this loop */
drhe23399f2005-07-22 00:31:39 +00001041 int nIn; /* Number of IN operators constraining this loop */
1042 int *aInLoop; /* Loop terminators for IN operators */
drh6b563442001-11-07 16:48:26 +00001043};
1044
1045/*
drh75897232000-05-29 14:26:00 +00001046** The WHERE clause processing routine has two halves. The
1047** first part does the start of the WHERE loop and the second
1048** half does the tail of the WHERE loop. An instance of
1049** this structure is returned by the first half and passed
1050** into the second half to give some continuity.
1051*/
1052struct WhereInfo {
1053 Parse *pParse;
drhad3cab52002-05-24 02:04:32 +00001054 SrcList *pTabList; /* List of tables in the join */
drh9012bcb2004-12-19 00:11:35 +00001055 int iTop; /* The very beginning of the WHERE loop */
drh19a775c2000-06-05 18:54:46 +00001056 int iContinue; /* Jump here to continue with next record */
1057 int iBreak; /* Jump here to break out of the loop */
drh6b563442001-11-07 16:48:26 +00001058 int nLevel; /* Number of nested loop */
1059 WhereLevel a[1]; /* Information about each nest loop in the WHERE */
drh75897232000-05-29 14:26:00 +00001060};
1061
1062/*
danielk1977b3bce662005-01-29 08:32:43 +00001063** A NameContext defines a context in which to resolve table and column
1064** names. The context consists of a list of tables (the pSrcList) field and
1065** a list of named expression (pEList). The named expression list may
1066** be NULL. The pSrc corresponds to the FROM clause of a SELECT or
1067** to the table being operated on by INSERT, UPDATE, or DELETE. The
1068** pEList corresponds to the result set of a SELECT and is NULL for
1069** other statements.
1070**
1071** NameContexts can be nested. When resolving names, the inner-most
1072** context is searched first. If no match is found, the next outer
1073** context is checked. If there is still no match, the next context
1074** is checked. This process continues until either a match is found
1075** or all contexts are check. When a match is found, the nRef member of
1076** the context containing the match is incremented.
1077**
1078** Each subquery gets a new NameContext. The pNext field points to the
1079** NameContext in the parent query. Thus the process of scanning the
1080** NameContext list corresponds to searching through successively outer
1081** subqueries looking for a match.
1082*/
1083struct NameContext {
1084 Parse *pParse; /* The parser */
1085 SrcList *pSrcList; /* One or more tables used to resolve names */
1086 ExprList *pEList; /* Optional list of named expressions */
1087 int nRef; /* Number of names resolved by this context */
1088 int nErr; /* Number of errors encountered while resolving names */
1089 u8 allowAgg; /* Aggregate functions allowed here */
drh13449892005-09-07 21:22:45 +00001090 u8 hasAgg; /* True if aggregates are seen */
drh06f65412005-11-03 02:03:13 +00001091 u8 isCheck; /* True if resolving names in a CHECK constraint */
danielk1977b3bce662005-01-29 08:32:43 +00001092 int nDepth; /* Depth of subquery recursion. 1 for no recursion */
drh13449892005-09-07 21:22:45 +00001093 AggInfo *pAggInfo; /* Information about aggregates at this level */
danielk1977b3bce662005-01-29 08:32:43 +00001094 NameContext *pNext; /* Next outer name context. NULL for outermost */
1095};
1096
1097/*
drh9bb61fe2000-06-05 16:01:39 +00001098** An instance of the following structure contains all information
1099** needed to generate code for a single SELECT statement.
drha76b5df2002-02-23 02:32:10 +00001100**
drhd11d3822002-06-21 23:01:49 +00001101** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0.
1102** If there is a LIMIT clause, the parser sets nLimit to the value of the
1103** limit and nOffset to the value of the offset (or 0 if there is not
1104** offset). But later on, nLimit and nOffset become the memory locations
1105** in the VDBE that record the limit and offset counters.
drh0342b1f2005-09-01 03:07:44 +00001106**
1107** addrOpenVirt[] entries contain the address of OP_OpenVirtual opcodes.
1108** These addresses must be stored so that we can go back and fill in
1109** the P3_KEYINFO and P2 parameters later. Neither the KeyInfo nor
1110** the number of columns in P2 can be computed at the same time
1111** as the OP_OpenVirtual instruction is coded because not
1112** enough information about the compound query is known at that point.
1113** The KeyInfo for addrOpenVirt[0] and [1] contains collating sequences
1114** for the result set. The KeyInfo for addrOpenVirt[2] contains collating
1115** sequences for the ORDER BY clause.
drh9bb61fe2000-06-05 16:01:39 +00001116*/
1117struct Select {
drh9bb61fe2000-06-05 16:01:39 +00001118 ExprList *pEList; /* The fields of the result */
drh7b58dae2003-07-20 01:16:46 +00001119 u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
1120 u8 isDistinct; /* True if the DISTINCT keyword is present */
drh0342b1f2005-09-01 03:07:44 +00001121 u8 isResolved; /* True once sqlite3SelectResolve() has run. */
1122 u8 isAgg; /* True if this is an aggregate query */
1123 u8 usesVirt; /* True if uses an OpenVirtual opcode */
drh4b14b4d2005-09-19 17:35:53 +00001124 u8 disallowOrderBy; /* Do not allow an ORDER BY to be attached if TRUE */
drhad3cab52002-05-24 02:04:32 +00001125 SrcList *pSrc; /* The FROM clause */
drh9bb61fe2000-06-05 16:01:39 +00001126 Expr *pWhere; /* The WHERE clause */
1127 ExprList *pGroupBy; /* The GROUP BY clause */
1128 Expr *pHaving; /* The HAVING clause */
1129 ExprList *pOrderBy; /* The ORDER BY clause */
drh967e8b72000-06-21 13:59:10 +00001130 Select *pPrior; /* Prior select in a compound select statement */
drh0342b1f2005-09-01 03:07:44 +00001131 Select *pRightmost; /* Right-most select in a compound select statement */
danielk1977a2dc3b12005-02-05 12:48:48 +00001132 Expr *pLimit; /* LIMIT expression. NULL means not used. */
1133 Expr *pOffset; /* OFFSET expression. NULL means not used. */
drh7b58dae2003-07-20 01:16:46 +00001134 int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */
drh0342b1f2005-09-01 03:07:44 +00001135 int addrOpenVirt[3]; /* OP_OpenVirtual opcodes related to this select */
drh9bb61fe2000-06-05 16:01:39 +00001136};
1137
1138/*
drhfef52082000-06-06 01:50:43 +00001139** The results of a select can be distributed in several ways.
1140*/
drh13449892005-09-07 21:22:45 +00001141#define SRT_Union 1 /* Store result as keys in an index */
1142#define SRT_Except 2 /* Remove result from a UNION index */
1143#define SRT_Discard 3 /* Do not save the results anywhere */
drhfef52082000-06-06 01:50:43 +00001144
drh13449892005-09-07 21:22:45 +00001145/* The ORDER BY clause is ignored for all of the above */
1146#define IgnorableOrderby(X) (X<=SRT_Discard)
1147
1148#define SRT_Callback 4 /* Invoke a callback with each row of result */
1149#define SRT_Mem 5 /* Store result in a memory cell */
1150#define SRT_Set 6 /* Store non-null results as keys in an index */
drhd49c16e2005-09-08 02:00:25 +00001151#define SRT_Table 7 /* Store result as data with an automatic rowid */
1152#define SRT_VirtualTab 8 /* Create virtual table and store like SRT_Table */
drh9d2985c2005-09-08 01:58:42 +00001153#define SRT_Subroutine 9 /* Call a subroutine to handle results */
drhec7429a2005-10-06 16:53:14 +00001154#define SRT_Exists 10 /* Store 1 if the result is not empty */
drh22827922000-06-06 17:27:05 +00001155
1156/*
drhf57b3392001-10-08 13:22:32 +00001157** An SQL parser context. A copy of this structure is passed through
1158** the parser and down into all the parser action routine in order to
1159** carry around information that is global to the entire parse.
drhf1974842004-11-05 03:56:00 +00001160**
1161** The structure is divided into two parts. When the parser and code
1162** generate call themselves recursively, the first part of the structure
1163** is constant but the second part is reset at the beginning and end of
1164** each recursion.
drh75897232000-05-29 14:26:00 +00001165*/
1166struct Parse {
drh9bb575f2004-09-06 17:24:11 +00001167 sqlite3 *db; /* The main database structure */
drh4c504392000-10-16 22:06:40 +00001168 int rc; /* Return code from execution */
drh75897232000-05-29 14:26:00 +00001169 char *zErrMsg; /* An error message */
drh75897232000-05-29 14:26:00 +00001170 Vdbe *pVdbe; /* An engine for executing database bytecode */
drh836faa42003-01-11 13:30:57 +00001171 u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */
drhe0bc4042002-06-25 01:09:11 +00001172 u8 nameClash; /* A permanent table name clashes with temp table name */
drha6ecd332004-06-10 00:29:09 +00001173 u8 checkSchema; /* Causes schema cookie check after an error */
drh205f48e2004-11-05 00:43:11 +00001174 u8 nested; /* Number of nested calls to the parser/code generator */
drh75897232000-05-29 14:26:00 +00001175 int nErr; /* Number of errors seen */
drh832508b2002-03-02 17:04:07 +00001176 int nTab; /* Number of previously allocated VDBE cursors */
drh19a775c2000-06-05 18:54:46 +00001177 int nMem; /* Number of memory cells used so far */
drhfef52082000-06-06 01:50:43 +00001178 int nSet; /* Number of sets used so far */
drhffe07b22005-11-03 00:41:17 +00001179 int ckOffset; /* Stack offset to data used by CHECK constraints */
drh80242052004-06-09 00:48:12 +00001180 u32 writeMask; /* Start a write transaction on these databases */
drhfcd35c72005-05-21 02:48:08 +00001181 u32 cookieMask; /* Bitmask of schema verified databases */
1182 int cookieGoto; /* Address of OP_Goto to cookie verifier subroutine */
1183 int cookieValue[MAX_ATTACHED+2]; /* Values of cookies to verify */
drhf1974842004-11-05 03:56:00 +00001184
1185 /* Above is constant between recursions. Below is reset before and after
1186 ** each recursion */
1187
1188 int nVar; /* Number of '?' variables seen in the SQL so far */
1189 int nVarExpr; /* Number of used slots in apVarExpr[] */
1190 int nVarExprAlloc; /* Number of allocated slots in apVarExpr[] */
1191 Expr **apVarExpr; /* Pointers to :aaa and $aaaa wildcard expressions */
1192 u8 explain; /* True if the EXPLAIN flag is found on the query */
drhf1974842004-11-05 03:56:00 +00001193 Token sErrToken; /* The token at which the error occurred */
1194 Token sNameToken; /* Token with unqualified schema object name */
1195 Token sLastToken; /* The last token parsed */
1196 const char *zSql; /* All SQL text */
1197 const char *zTail; /* All SQL text past the last semicolon parsed */
1198 Table *pNewTable; /* A table being constructed by CREATE TABLE */
1199 Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */
1200 TriggerStack *trigStack; /* Trigger actions being coded */
1201 const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
drh75897232000-05-29 14:26:00 +00001202};
1203
danielk1977d99bc932002-05-16 00:13:12 +00001204/*
drh85e20962003-04-25 17:52:11 +00001205** An instance of the following structure can be declared on a stack and used
1206** to save the Parse.zAuthContext value so that it can be restored later.
1207*/
1208struct AuthContext {
1209 const char *zAuthContext; /* Put saved Parse.zAuthContext here */
1210 Parse *pParse; /* The Parse structure */
1211};
1212
1213/*
drhf0863fe2005-06-12 21:35:51 +00001214** Bitfield flags for P2 value in OP_Insert and OP_Delete
rdcb0c374f2004-02-20 22:53:38 +00001215*/
1216#define OPFLAG_NCHANGE 1 /* Set to update db->nChange */
1217#define OPFLAG_LASTROWID 2 /* Set to update db->lastRowid */
rdcb0c374f2004-02-20 22:53:38 +00001218
1219/*
danielk1977d99bc932002-05-16 00:13:12 +00001220 * Each trigger present in the database schema is stored as an instance of
1221 * struct Trigger.
1222 *
1223 * Pointers to instances of struct Trigger are stored in two ways.
drh9bb575f2004-09-06 17:24:11 +00001224 * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
danielk1977d99bc932002-05-16 00:13:12 +00001225 * database). This allows Trigger structures to be retrieved by name.
1226 * 2. All triggers associated with a single table form a linked list, using the
drhad3cab52002-05-24 02:04:32 +00001227 * pNext member of struct Trigger. A pointer to the first element of the
1228 * linked list is stored as the "pTrigger" member of the associated
1229 * struct Table.
danielk1977d99bc932002-05-16 00:13:12 +00001230 *
drhad3cab52002-05-24 02:04:32 +00001231 * The "step_list" member points to the first element of a linked list
1232 * containing the SQL statements specified as the trigger program.
danielk1977d99bc932002-05-16 00:13:12 +00001233 */
danielk1977c3f9bad2002-05-15 08:30:12 +00001234struct Trigger {
drhdc379452002-05-15 12:45:43 +00001235 char *name; /* The name of the trigger */
1236 char *table; /* The table or view to which the trigger applies */
drhf0f258b2003-04-21 18:48:45 +00001237 u8 iDb; /* Database containing this trigger */
drh79a519c2003-05-17 19:04:03 +00001238 u8 iTabDb; /* Database containing Trigger.table */
drhf0f258b2003-04-21 18:48:45 +00001239 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */
drhdca76842004-12-07 14:06:13 +00001240 u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
drhdc379452002-05-15 12:45:43 +00001241 Expr *pWhen; /* The WHEN clause of the expresion (may be NULL) */
1242 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger,
danielk1977d99bc932002-05-16 00:13:12 +00001243 the <column-list> is stored here */
drhdc379452002-05-15 12:45:43 +00001244 int foreach; /* One of TK_ROW or TK_STATEMENT */
drh4312db52003-06-03 01:47:11 +00001245 Token nameToken; /* Token containing zName. Use during parsing only */
danielk1977c3f9bad2002-05-15 08:30:12 +00001246
drhdc379452002-05-15 12:45:43 +00001247 TriggerStep *step_list; /* Link list of trigger program steps */
drhdc379452002-05-15 12:45:43 +00001248 Trigger *pNext; /* Next trigger associated with the table */
danielk1977c3f9bad2002-05-15 08:30:12 +00001249};
1250
danielk1977d99bc932002-05-16 00:13:12 +00001251/*
drhdca76842004-12-07 14:06:13 +00001252** A trigger is either a BEFORE or an AFTER trigger. The following constants
1253** determine which.
1254**
1255** If there are multiple triggers, you might of some BEFORE and some AFTER.
1256** In that cases, the constants below can be ORed together.
1257*/
1258#define TRIGGER_BEFORE 1
1259#define TRIGGER_AFTER 2
1260
1261/*
danielk1977d99bc932002-05-16 00:13:12 +00001262 * An instance of struct TriggerStep is used to store a single SQL statement
1263 * that is a part of a trigger-program.
1264 *
1265 * Instances of struct TriggerStep are stored in a singly linked list (linked
1266 * using the "pNext" member) referenced by the "step_list" member of the
1267 * associated struct Trigger instance. The first element of the linked list is
1268 * the first step of the trigger-program.
1269 *
1270 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
1271 * "SELECT" statement. The meanings of the other members is determined by the
1272 * value of "op" as follows:
1273 *
1274 * (op == TK_INSERT)
1275 * orconf -> stores the ON CONFLICT algorithm
1276 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then
1277 * this stores a pointer to the SELECT statement. Otherwise NULL.
1278 * target -> A token holding the name of the table to insert into.
1279 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
1280 * this stores values to be inserted. Otherwise NULL.
1281 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ...
drhad3cab52002-05-24 02:04:32 +00001282 * statement, then this stores the column-names to be
1283 * inserted into.
danielk1977d99bc932002-05-16 00:13:12 +00001284 *
1285 * (op == TK_DELETE)
1286 * target -> A token holding the name of the table to delete from.
1287 * pWhere -> The WHERE clause of the DELETE statement if one is specified.
1288 * Otherwise NULL.
1289 *
1290 * (op == TK_UPDATE)
1291 * target -> A token holding the name of the table to update rows of.
1292 * pWhere -> The WHERE clause of the UPDATE statement if one is specified.
1293 * Otherwise NULL.
1294 * pExprList -> A list of the columns to update and the expressions to update
danielk19774adee202004-05-08 08:23:19 +00001295 * them to. See sqlite3Update() documentation of "pChanges"
drhad3cab52002-05-24 02:04:32 +00001296 * argument.
danielk1977d99bc932002-05-16 00:13:12 +00001297 *
1298 */
1299struct TriggerStep {
1300 int op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1301 int orconf; /* OE_Rollback etc. */
drha69d9162003-04-17 22:57:53 +00001302 Trigger *pTrig; /* The trigger that this step is a part of */
danielk1977c3f9bad2002-05-15 08:30:12 +00001303
danielk1977d99bc932002-05-16 00:13:12 +00001304 Select *pSelect; /* Valid for SELECT and sometimes
1305 INSERT steps (when pExprList == 0) */
1306 Token target; /* Valid for DELETE, UPDATE, INSERT steps */
1307 Expr *pWhere; /* Valid for DELETE, UPDATE steps */
1308 ExprList *pExprList; /* Valid for UPDATE statements and sometimes
1309 INSERT steps (when pSelect == 0) */
1310 IdList *pIdList; /* Valid for INSERT statements only */
1311
1312 TriggerStep * pNext; /* Next in the link-list */
1313};
1314
1315/*
1316 * An instance of struct TriggerStack stores information required during code
1317 * generation of a single trigger program. While the trigger program is being
1318 * coded, its associated TriggerStack instance is pointed to by the
1319 * "pTriggerStack" member of the Parse structure.
1320 *
1321 * The pTab member points to the table that triggers are being coded on. The
1322 * newIdx member contains the index of the vdbe cursor that points at the temp
1323 * table that stores the new.* references. If new.* references are not valid
1324 * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1325 * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1326 *
1327 * The ON CONFLICT policy to be used for the trigger program steps is stored
1328 * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1329 * specified for individual triggers steps is used.
1330 *
1331 * struct TriggerStack has a "pNext" member, to allow linked lists to be
1332 * constructed. When coding nested triggers (triggers fired by other triggers)
1333 * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1334 * pointer. Once the nested trigger has been coded, the pNext value is restored
1335 * to the pTriggerStack member of the Parse stucture and coding of the parent
1336 * trigger continues.
1337 *
1338 * Before a nested trigger is coded, the linked list pointed to by the
1339 * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1340 * recursively. If this condition is detected, the nested trigger is not coded.
1341 */
1342struct TriggerStack {
1343 Table *pTab; /* Table that triggers are currently being coded on */
1344 int newIdx; /* Index of vdbe cursor to "new" temp table */
1345 int oldIdx; /* Index of vdbe cursor to "old" temp table */
1346 int orconf; /* Current orconf policy */
danielk19776f349032002-06-11 02:25:40 +00001347 int ignoreJump; /* where to jump to for a RAISE(IGNORE) */
drhe22a3342003-04-22 20:30:37 +00001348 Trigger *pTrigger; /* The trigger currently being coded */
1349 TriggerStack *pNext; /* Next trigger down on the trigger stack */
danielk1977d99bc932002-05-16 00:13:12 +00001350};
1351
1352/*
drhf26e09c2003-05-31 16:21:12 +00001353** The following structure contains information used by the sqliteFix...
1354** routines as they walk the parse tree to make database references
1355** explicit.
1356*/
1357typedef struct DbFixer DbFixer;
1358struct DbFixer {
1359 Parse *pParse; /* The parsing context. Error messages written here */
1360 const char *zDb; /* Make sure all objects are contained in this database */
1361 const char *zType; /* Type of the container - used for error messages */
1362 const Token *pName; /* Name of the container - used for error messages */
1363};
1364
1365/*
drh234c39d2004-07-24 03:30:47 +00001366** A pointer to this structure is used to communicate information
1367** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
1368*/
1369typedef struct {
drh9bb575f2004-09-06 17:24:11 +00001370 sqlite3 *db; /* The database being initialized */
drh234c39d2004-07-24 03:30:47 +00001371 char **pzErrMsg; /* Error message stored here */
1372} InitData;
1373
drhb6c29892004-11-22 19:12:19 +00001374/*
danielk1977d99bc932002-05-16 00:13:12 +00001375 * This global flag is set for performance testing of triggers. When it is set
1376 * SQLite will perform the overhead of building new and old trigger references
1377 * even when no triggers exist
1378 */
drh38f82712004-06-18 17:10:16 +00001379extern int sqlite3_always_code_trigger_setup;
danielk1977c3f9bad2002-05-15 08:30:12 +00001380
drh75897232000-05-29 14:26:00 +00001381/*
drh49285702005-09-17 15:20:26 +00001382** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production
1383** builds) or a function call (for debugging). If it is a function call,
1384** it allows the operator to set a breakpoint at the spot where database
1385** corruption is first detected.
1386*/
1387#ifdef SQLITE_DEBUG
1388 extern int sqlite3Corrupt(void);
1389# define SQLITE_CORRUPT_BKPT sqlite3Corrupt()
1390#else
1391# define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT
1392#endif
1393
1394/*
drh75897232000-05-29 14:26:00 +00001395** Internal function prototypes
1396*/
danielk19774adee202004-05-08 08:23:19 +00001397int sqlite3StrICmp(const char *, const char *);
1398int sqlite3StrNICmp(const char *, const char *, int);
1399int sqlite3HashNoCase(const char *, int);
danielk19778a6b5412004-05-24 07:04:25 +00001400int sqlite3IsNumber(const char*, int*, u8);
danielk19774adee202004-05-08 08:23:19 +00001401int sqlite3Compare(const char *, const char *);
1402int sqlite3SortCompare(const char *, const char *);
1403void sqlite3RealToSortable(double r, char *);
danielk19772c336542005-01-13 02:14:23 +00001404#ifdef SQLITE_MEMDEBUG
danielk19774adee202004-05-08 08:23:19 +00001405 void *sqlite3Malloc_(int,int,char*,int);
1406 void sqlite3Free_(void*,char*,int);
1407 void *sqlite3Realloc_(void*,int,char*,int);
1408 char *sqlite3StrDup_(const char*,char*,int);
1409 char *sqlite3StrNDup_(const char*, int,char*,int);
1410 void sqlite3CheckMemory(void*,int);
drhdcc581c2000-05-30 13:44:19 +00001411#else
drhbdb43832004-06-18 17:45:11 +00001412 void *sqlite3Malloc(int);
1413 void *sqlite3MallocRaw(int);
1414 void sqlite3Free(void*);
1415 void *sqlite3Realloc(void*,int);
1416 char *sqlite3StrDup(const char*);
1417 char *sqlite3StrNDup(const char*, int);
danielk19774adee202004-05-08 08:23:19 +00001418# define sqlite3CheckMemory(a,b)
drh132d8d62005-05-22 20:12:37 +00001419# define sqlite3MallocX sqlite3Malloc
drhdcc581c2000-05-30 13:44:19 +00001420#endif
drh53f733c2005-09-16 02:38:09 +00001421void sqlite3ReallocOrFree(void**,int);
drh998da3a2004-06-19 15:22:56 +00001422void sqlite3FreeX(void*);
drh132d8d62005-05-22 20:12:37 +00001423void *sqlite3MallocX(int);
danielk19774adee202004-05-08 08:23:19 +00001424char *sqlite3MPrintf(const char*, ...);
1425char *sqlite3VMPrintf(const char*, va_list);
drhe54ca3f2004-06-07 01:52:14 +00001426void sqlite3DebugPrintf(const char*, ...);
drhfe63d1c2004-09-08 20:13:04 +00001427void *sqlite3TextToPtr(const char*);
drh41f58522005-06-06 15:06:39 +00001428void sqlite3SetString(char **, ...);
danielk19774adee202004-05-08 08:23:19 +00001429void sqlite3ErrorMsg(Parse*, const char*, ...);
1430void sqlite3Dequote(char*);
drhd2687b72005-08-12 22:56:09 +00001431void sqlite3DequoteExpr(Expr*);
danielk19774adee202004-05-08 08:23:19 +00001432int sqlite3KeywordCode(const char*, int);
1433int sqlite3RunParser(Parse*, const char*, char **);
drh80242052004-06-09 00:48:12 +00001434void sqlite3FinishCoding(Parse*);
drhe4e72072004-11-23 01:47:30 +00001435Expr *sqlite3Expr(int, Expr*, Expr*, const Token*);
drh4e0cff62004-11-05 05:10:28 +00001436Expr *sqlite3RegisterExpr(Parse*,Token*);
drh91bb0ee2004-09-01 03:06:34 +00001437Expr *sqlite3ExprAnd(Expr*, Expr*);
danielk19774adee202004-05-08 08:23:19 +00001438void sqlite3ExprSpan(Expr*,Token*,Token*);
1439Expr *sqlite3ExprFunction(ExprList*, Token*);
drhfa6bc002004-09-07 16:19:52 +00001440void sqlite3ExprAssignVarNumber(Parse*, Expr*);
danielk19774adee202004-05-08 08:23:19 +00001441void sqlite3ExprDelete(Expr*);
1442ExprList *sqlite3ExprListAppend(ExprList*,Expr*,Token*);
1443void sqlite3ExprListDelete(ExprList*);
drh9bb575f2004-09-06 17:24:11 +00001444int sqlite3Init(sqlite3*, char**);
drh234c39d2004-07-24 03:30:47 +00001445int sqlite3InitCallback(void*, int, char**, char**);
danielk197791cf71b2004-06-26 06:37:06 +00001446void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
drh9bb575f2004-09-06 17:24:11 +00001447void sqlite3ResetInternalSchema(sqlite3*, int);
danielk19774adee202004-05-08 08:23:19 +00001448void sqlite3BeginParse(Parse*,int);
drh9bb575f2004-09-06 17:24:11 +00001449void sqlite3RollbackInternalChanges(sqlite3*);
1450void sqlite3CommitInternalChanges(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00001451Table *sqlite3ResultSetOfSelect(Parse*,char*,Select*);
1452void sqlite3OpenMasterTable(Vdbe *v, int);
danielk1977cbb18d22004-05-28 11:37:27 +00001453void sqlite3StartTable(Parse*,Token*,Token*,Token*,int,int);
danielk19774adee202004-05-08 08:23:19 +00001454void sqlite3AddColumn(Parse*,Token*);
1455void sqlite3AddNotNull(Parse*, int);
drh205f48e2004-11-05 00:43:11 +00001456void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int);
drhffe07b22005-11-03 00:41:17 +00001457void sqlite3AddCheckConstraint(Parse*, Expr*);
drh487e2622005-06-25 18:42:14 +00001458void sqlite3AddColumnType(Parse*,Token*);
danielk19777977a172004-11-09 12:44:37 +00001459void sqlite3AddDefaultValue(Parse*,Expr*);
drhd3d39e92004-05-20 22:16:29 +00001460void sqlite3AddCollateType(Parse*, const char*, int);
danielk197719a8e7e2005-03-17 05:03:38 +00001461void sqlite3EndTable(Parse*,Token*,Token*,Select*);
drhb7f91642004-10-31 02:22:47 +00001462
1463#ifndef SQLITE_OMIT_VIEW
1464 void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int);
1465 int sqlite3ViewGetColumnNames(Parse*,Table*);
1466#else
1467# define sqlite3ViewGetColumnNames(A,B) 0
1468#endif
1469
danielk1977a8858102004-05-28 12:11:21 +00001470void sqlite3DropTable(Parse*, SrcList*, int);
drh9bb575f2004-09-06 17:24:11 +00001471void sqlite3DeleteTable(sqlite3*, Table*);
danielk19774adee202004-05-08 08:23:19 +00001472void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
drh13449892005-09-07 21:22:45 +00001473int sqlite3ArrayAllocate(void**,int,int);
danielk19774adee202004-05-08 08:23:19 +00001474IdList *sqlite3IdListAppend(IdList*, Token*);
1475int sqlite3IdListIndex(IdList*,const char*);
1476SrcList *sqlite3SrcListAppend(SrcList*, Token*, Token*);
1477void sqlite3SrcListAddAlias(SrcList*, Token*);
1478void sqlite3SrcListAssignCursors(Parse*, SrcList*);
1479void sqlite3IdListDelete(IdList*);
1480void sqlite3SrcListDelete(SrcList*);
danielk19770202b292004-06-09 09:55:16 +00001481void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
danielk1977ef2cb632004-05-29 02:37:19 +00001482 Token*);
danielk19774adee202004-05-08 08:23:19 +00001483void sqlite3DropIndex(Parse*, SrcList*);
1484void sqlite3AddKeyType(Vdbe*, ExprList*);
1485void sqlite3AddIdxKeyType(Vdbe*, Index*);
danielk1977b3bce662005-01-29 08:32:43 +00001486int sqlite3Select(Parse*, Select*, int, int, Select*, int, int*, char *aff);
danielk19774adee202004-05-08 08:23:19 +00001487Select *sqlite3SelectNew(ExprList*,SrcList*,Expr*,ExprList*,Expr*,ExprList*,
danielk1977a2dc3b12005-02-05 12:48:48 +00001488 int,Expr*,Expr*);
danielk19774adee202004-05-08 08:23:19 +00001489void sqlite3SelectDelete(Select*);
1490void sqlite3SelectUnbind(Select*);
1491Table *sqlite3SrcListLookup(Parse*, SrcList*);
1492int sqlite3IsReadOnly(Parse*, Table*, int);
drhad6d9462004-09-19 02:15:24 +00001493void sqlite3OpenTableForReading(Vdbe*, int iCur, Table*);
drhb6c29892004-11-22 19:12:19 +00001494void sqlite3OpenTable(Vdbe*, int iCur, Table*, int);
danielk19774adee202004-05-08 08:23:19 +00001495void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
1496void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
drhf8db1bc2005-04-22 02:38:37 +00001497WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**);
danielk19774adee202004-05-08 08:23:19 +00001498void sqlite3WhereEnd(WhereInfo*);
1499void sqlite3ExprCode(Parse*, Expr*);
drh25303782004-12-07 15:41:48 +00001500void sqlite3ExprCodeAndCache(Parse*, Expr*);
drhf9b596e2004-05-26 16:54:42 +00001501int sqlite3ExprCodeExprList(Parse*, ExprList*);
danielk19774adee202004-05-08 08:23:19 +00001502void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
1503void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
drh205f48e2004-11-05 00:43:11 +00001504void sqlite3NextedParse(Parse*, const char*, ...);
drh9bb575f2004-09-06 17:24:11 +00001505Table *sqlite3FindTable(sqlite3*,const char*, const char*);
danielk19774adee202004-05-08 08:23:19 +00001506Table *sqlite3LocateTable(Parse*,const char*, const char*);
drh9bb575f2004-09-06 17:24:11 +00001507Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
1508void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
1509void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
danielk19774adee202004-05-08 08:23:19 +00001510void sqlite3Vacuum(Parse*, Token*);
drh9bb575f2004-09-06 17:24:11 +00001511int sqlite3RunVacuum(char**, sqlite3*);
drha99db3b2004-06-19 14:49:12 +00001512char *sqlite3NameFromToken(Token*);
danielk19774adee202004-05-08 08:23:19 +00001513int sqlite3ExprCheck(Parse*, Expr*, int, int*);
danielk19774adee202004-05-08 08:23:19 +00001514int sqlite3ExprCompare(Expr*, Expr*);
drhcce7d172000-05-31 15:34:51 +00001515int sqliteFuncId(Token*);
danielk1977b3bce662005-01-29 08:32:43 +00001516int sqlite3ExprResolveNames(NameContext *, Expr *);
danielk1977a58fdfb2005-02-08 07:50:40 +00001517int sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
drh5d9a4af2005-08-30 00:54:01 +00001518int sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
danielk19774adee202004-05-08 08:23:19 +00001519Vdbe *sqlite3GetVdbe(Parse*);
1520void sqlite3Randomness(int, void*);
drh9bb575f2004-09-06 17:24:11 +00001521void sqlite3RollbackAll(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00001522void sqlite3CodeVerifySchema(Parse*, int);
drh684917c2004-10-05 02:41:42 +00001523void sqlite3BeginTransaction(Parse*, int);
danielk19774adee202004-05-08 08:23:19 +00001524void sqlite3CommitTransaction(Parse*);
1525void sqlite3RollbackTransaction(Parse*);
1526int sqlite3ExprIsConstant(Expr*);
drheb55bd22005-06-30 17:04:21 +00001527int sqlite3ExprIsConstantOrFunction(Expr*);
danielk19774adee202004-05-08 08:23:19 +00001528int sqlite3ExprIsInteger(Expr*, int*);
1529int sqlite3IsRowid(const char*);
drh9bb575f2004-09-06 17:24:11 +00001530void sqlite3GenerateRowDelete(sqlite3*, Vdbe*, Table*, int, int);
1531void sqlite3GenerateRowIndexDelete(sqlite3*, Vdbe*, Table*, int, char*);
drh51846b52004-05-28 16:00:21 +00001532void sqlite3GenerateIndexKey(Vdbe*, Index*, int);
danielk19774adee202004-05-08 08:23:19 +00001533void sqlite3GenerateConstraintChecks(Parse*,Table*,int,char*,int,int,int,int);
1534void sqlite3CompleteInsertion(Parse*, Table*, int, char*, int, int, int);
drh290c1942004-08-21 17:54:45 +00001535void sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
danielk19774adee202004-05-08 08:23:19 +00001536void sqlite3BeginWriteOperation(Parse*, int, int);
danielk19774adee202004-05-08 08:23:19 +00001537Expr *sqlite3ExprDup(Expr*);
1538void sqlite3TokenCopy(Token*, Token*);
1539ExprList *sqlite3ExprListDup(ExprList*);
1540SrcList *sqlite3SrcListDup(SrcList*);
1541IdList *sqlite3IdListDup(IdList*);
1542Select *sqlite3SelectDup(Select*);
drh9bb575f2004-09-06 17:24:11 +00001543FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
1544void sqlite3RegisterBuiltinFunctions(sqlite3*);
1545void sqlite3RegisterDateTimeFunctions(sqlite3*);
1546int sqlite3SafetyOn(sqlite3*);
1547int sqlite3SafetyOff(sqlite3*);
1548int sqlite3SafetyCheck(sqlite3*);
1549void sqlite3ChangeCookie(sqlite3*, Vdbe*, int);
drhb7f91642004-10-31 02:22:47 +00001550
1551#ifndef SQLITE_OMIT_TRIGGER
1552 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
1553 int,Expr*,int);
1554 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
1555 void sqlite3DropTrigger(Parse*, SrcList*);
1556 void sqlite3DropTriggerPtr(Parse*, Trigger*, int);
drhdca76842004-12-07 14:06:13 +00001557 int sqlite3TriggersExist(Parse*, Table*, int, ExprList*);
drhb7f91642004-10-31 02:22:47 +00001558 int sqlite3CodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
1559 int, int);
1560 void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
1561 void sqlite3DeleteTriggerStep(TriggerStep*);
1562 TriggerStep *sqlite3TriggerSelectStep(Select*);
1563 TriggerStep *sqlite3TriggerInsertStep(Token*, IdList*, ExprList*,Select*,int);
1564 TriggerStep *sqlite3TriggerUpdateStep(Token*, ExprList*, Expr*, int);
1565 TriggerStep *sqlite3TriggerDeleteStep(Token*, Expr*);
1566 void sqlite3DeleteTrigger(Trigger*);
1567 void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
1568#else
1569# define sqlite3TriggersExist(A,B,C,D,E,F) 0
1570# define sqlite3DeleteTrigger(A)
1571# define sqlite3DropTriggerPtr(A,B,C)
1572# define sqlite3UnlinkAndDeleteTrigger(A,B,C)
1573# define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I) 0
1574#endif
1575
danielk19774adee202004-05-08 08:23:19 +00001576int sqlite3JoinType(Parse*, Token*, Token*, Token*);
danielk19770202b292004-06-09 09:55:16 +00001577void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
danielk19774adee202004-05-08 08:23:19 +00001578void sqlite3DeferForeignKey(Parse*, int);
drhed6c8672003-01-12 18:02:16 +00001579#ifndef SQLITE_OMIT_AUTHORIZATION
danielk19774adee202004-05-08 08:23:19 +00001580 void sqlite3AuthRead(Parse*,Expr*,SrcList*);
1581 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
1582 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
1583 void sqlite3AuthContextPop(AuthContext*);
drhed6c8672003-01-12 18:02:16 +00001584#else
danielk19774adee202004-05-08 08:23:19 +00001585# define sqlite3AuthRead(a,b,c)
1586# define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK
1587# define sqlite3AuthContextPush(a,b,c)
1588# define sqlite3AuthContextPop(a) ((void)(a))
drhed6c8672003-01-12 18:02:16 +00001589#endif
drh25d65432004-07-22 15:02:25 +00001590void sqlite3Attach(Parse*, Token*, Token*, int, Token*);
danielk19774adee202004-05-08 08:23:19 +00001591void sqlite3Detach(Parse*, Token*);
drh9bb575f2004-09-06 17:24:11 +00001592int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
drh90f5ecb2004-07-22 01:19:35 +00001593 int omitJournal, int nCache, Btree **ppBtree);
danielk19774adee202004-05-08 08:23:19 +00001594int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
1595int sqlite3FixSrcList(DbFixer*, SrcList*);
1596int sqlite3FixSelect(DbFixer*, Select*);
1597int sqlite3FixExpr(DbFixer*, Expr*);
1598int sqlite3FixExprList(DbFixer*, ExprList*);
1599int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
drh487e2622005-06-25 18:42:14 +00001600int sqlite3AtoF(const char *z, double*);
danielk19776f8a5032004-05-10 10:34:51 +00001601char *sqlite3_snprintf(int,char*,const char*,...);
drhfec19aa2004-05-19 20:41:03 +00001602int sqlite3GetInt32(const char *, int*);
drhfec19aa2004-05-19 20:41:03 +00001603int sqlite3FitsIn64Bits(const char *);
danielk19776622cce2004-05-20 11:00:52 +00001604int sqlite3utf16ByteLen(const void *pData, int nChar);
1605int sqlite3utf8CharLen(const char *pData, int nByte);
drh4e5ffc52004-08-31 00:52:37 +00001606int sqlite3ReadUtf8(const unsigned char *);
danielk1977192ac1d2004-05-10 07:17:30 +00001607int sqlite3PutVarint(unsigned char *, u64);
danielk197790e4d952004-05-10 10:05:53 +00001608int sqlite3GetVarint(const unsigned char *, u64 *);
drh6d2fb152004-05-14 16:50:06 +00001609int sqlite3GetVarint32(const unsigned char *, u32 *);
danielk1977192ac1d2004-05-10 07:17:30 +00001610int sqlite3VarintLen(u64 v);
danielk1977a37cdde2004-05-16 11:15:36 +00001611void sqlite3IndexAffinityStr(Vdbe *, Index *);
1612void sqlite3TableAffinityStr(Vdbe *, Table *);
danielk1977e014a832004-05-17 10:48:57 +00001613char sqlite3CompareAffinity(Expr *pExpr, char aff2);
danielk1977e014a832004-05-17 10:48:57 +00001614int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
danielk1977bf3b7212004-05-18 10:06:24 +00001615char sqlite3ExprAffinity(Expr *pExpr);
drheb2e1762004-05-27 01:53:56 +00001616int sqlite3atoi64(const char*, i64*);
drh9bb575f2004-09-06 17:24:11 +00001617void sqlite3Error(sqlite3*, int, const char*,...);
danielk1977cbb18d22004-05-28 11:37:27 +00001618void *sqlite3HexToBlob(const char *z);
danielk1977ef2cb632004-05-29 02:37:19 +00001619int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
danielk1977f20b21c2004-05-31 23:56:42 +00001620const char *sqlite3ErrStr(int);
danielk1977d02eb1f2004-06-06 09:44:03 +00001621int sqlite3ReadUniChar(const char *zStr, int *pOffset, u8 *pEnc, int fold);
danielk19778a414492004-06-29 08:59:35 +00001622int sqlite3ReadSchema(Parse *pParse);
drh9bb575f2004-09-06 17:24:11 +00001623CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
danielk19770202b292004-06-09 09:55:16 +00001624CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
danielk19777cedc8d2004-06-10 10:50:08 +00001625CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
1626int sqlite3CheckCollSeq(Parse *, CollSeq *);
1627int sqlite3CheckIndexCollSeq(Parse *, Index *);
danielk1977d8123362004-06-12 09:25:12 +00001628int sqlite3CheckObjectName(Parse *, const char *);
danielk1977b28af712004-06-21 06:50:26 +00001629void sqlite3VdbeSetChanges(sqlite3 *, int);
danielk1977f4618892004-06-28 13:09:11 +00001630void sqlite3utf16Substr(sqlite3_context *,int,sqlite3_value **);
danielk19774e6af132004-06-10 14:01:08 +00001631
1632const void *sqlite3ValueText(sqlite3_value*, u8);
1633int sqlite3ValueBytes(sqlite3_value*, u8);
danielk1977bfd6cce2004-06-18 04:24:54 +00001634void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8, void(*)(void*));
danielk19774e6af132004-06-10 14:01:08 +00001635void sqlite3ValueFree(sqlite3_value*);
drh4f26bb62005-09-08 14:17:20 +00001636sqlite3_value *sqlite3ValueNew(void);
drh9bb575f2004-09-06 17:24:11 +00001637sqlite3_value *sqlite3GetTransientValue(sqlite3*db);
danielk1977aee18ef2005-03-09 12:26:50 +00001638int sqlite3ValueFromExpr(Expr *, u8, u8, sqlite3_value **);
1639void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
drh4e5ffc52004-08-31 00:52:37 +00001640extern const unsigned char sqlite3UpperToLower[];
danielk1977a0bf2652004-11-04 14:30:04 +00001641void sqlite3RootPageMoved(Db*, int, int);
drh4343fea2004-11-05 23:46:15 +00001642void sqlite3Reindex(Parse*, Token*, Token*);
drh1f01ec12005-02-15 21:36:18 +00001643void sqlite3AlterFunctions(sqlite3*);
danielk19779fd2a9a2004-11-12 13:42:30 +00001644void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
1645int sqlite3GetToken(const unsigned char *, int *);
drh2958a4e2004-11-12 03:56:15 +00001646void sqlite3NestedParse(Parse*, const char*, ...);
drhd89bd002005-01-22 03:03:54 +00001647void sqlite3ExpirePreparedStatements(sqlite3*);
danielk1977b3bce662005-01-29 08:32:43 +00001648void sqlite3CodeSubselect(Parse *, Expr *);
1649int sqlite3SelectResolve(Parse *, Select *, NameContext *);
danielk1977aee18ef2005-03-09 12:26:50 +00001650void sqlite3ColumnDefault(Vdbe *, Table *, int);
danielk197719a8e7e2005-03-17 05:03:38 +00001651void sqlite3AlterFinishAddColumn(Parse *, Token *);
1652void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
drh2e66f0b2005-04-28 17:18:48 +00001653const char *sqlite3TestErrorName(int);
danielk19774dade032005-05-25 10:45:10 +00001654CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int);
drh8df447f2005-11-01 15:48:24 +00001655char sqlite3AffinityType(const Token*, int);
drh9f18e8a2005-07-08 12:13:04 +00001656void sqlite3Analyze(Parse*, Token*, Token*);
drha4afb652005-07-09 02:16:02 +00001657int sqlite3InvokeBusyHandler(BusyHandler*);
drhff2d5ea2005-07-23 00:41:48 +00001658int sqlite3FindDb(sqlite3*, Token*);
drh497e4462005-07-23 03:18:40 +00001659void sqlite3AnalysisLoad(sqlite3*,int iDB);
drh51147ba2005-07-23 22:59:55 +00001660void sqlite3DefaultRowEst(Index*);
drh55ef4d92005-08-14 01:20:37 +00001661void sqlite3RegisterLikeFunctions(sqlite3*, int);
drhd64fe2f2005-08-28 17:00:23 +00001662int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
danielk1977e3026632004-06-22 11:29:02 +00001663
danielk1977fd9a0a42005-05-24 12:01:00 +00001664#ifdef SQLITE_SSE
1665#include "sseInt.h"
1666#endif
1667
danielk1977e3026632004-06-22 11:29:02 +00001668#endif