blob: 5977c98305a92dd46263ef1016af7bb4318ea666 [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**
drh4b494d62006-01-12 12:43:36 +000014** @(#) $Id: sqliteInt.h,v 1.465 2006/01/12 12:43:36 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/*
drh824d7c12006-01-06 12:03:19 +000020** Extra interface definitions for those who need them
21*/
22#ifdef SQLITE_EXTRA
23# include "sqliteExtra.h"
24#endif
25
26/*
drh4b529d92005-09-13 00:00:00 +000027** Many people are failing to set -DNDEBUG=1 when compiling SQLite.
drhb27795c2005-09-13 00:02:16 +000028** Setting NDEBUG makes the code smaller and run faster. So the following
drh4b529d92005-09-13 00:00:00 +000029** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1
30** option is set. Thus NDEBUG becomes an opt-in rather than an opt-out
31** feature.
32*/
drh289ab072005-09-13 16:12:47 +000033#if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
drh4b529d92005-09-13 00:00:00 +000034# define NDEBUG 1
35#endif
36
37/*
drheb206252004-10-01 02:00:31 +000038** These #defines should enable >2GB file support on Posix if the
39** underlying operating system supports it. If the OS lacks
40** large file support, or if the OS is windows, these should be no-ops.
41**
42** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
43** on the compiler command line. This is necessary if you are compiling
44** on a recent machine (ex: RedHat 7.2) but you want your code to work
45** on an older machine (ex: RedHat 6.0). If you compile on RedHat 7.2
46** without this option, LFS is enable. But LFS does not exist in the kernel
47** in RedHat 6.0, so the code won't work. Hence, for maximum binary
48** portability you should omit LFS.
49**
50** Similar is true for MacOS. LFS is only supported on MacOS 9 and later.
51*/
52#ifndef SQLITE_DISABLE_LFS
53# define _LARGE_FILE 1
54# ifndef _FILE_OFFSET_BITS
55# define _FILE_OFFSET_BITS 64
56# endif
57# define _LARGEFILE_SOURCE 1
58#endif
59
drh1d482dd2004-05-31 18:23:07 +000060#include "sqlite3.h"
drhbeae3192001-09-22 18:12:08 +000061#include "hash.h"
drh75897232000-05-29 14:26:00 +000062#include "parse.h"
drh75897232000-05-29 14:26:00 +000063#include <stdio.h>
64#include <stdlib.h>
65#include <string.h>
66#include <assert.h>
drh52370e22005-01-21 21:31:40 +000067#include <stddef.h>
drh75897232000-05-29 14:26:00 +000068
drh967e8b72000-06-21 13:59:10 +000069/*
drhb37df7b2005-10-13 02:09:49 +000070** If compiling for a processor that lacks floating point support,
71** substitute integer for floating-point
72*/
73#ifdef SQLITE_OMIT_FLOATING_POINT
74# define double sqlite_int64
75# define LONGDOUBLE_TYPE sqlite_int64
76# define SQLITE_BIG_DBL (0x7fffffffffffffff)
77# define SQLITE_OMIT_DATETIME_FUNCS 1
78# define SQLITE_OMIT_TRACE 1
79#endif
80
81/*
drha1b351a2001-09-14 16:42:12 +000082** The maximum number of in-memory pages to use for the main database
danielk197724c8ab82005-02-09 01:40:23 +000083** table and for temporary tables. Internally, the MAX_PAGES and
84** TEMP_PAGES macros are used. To override the default values at
85** compilation time, the SQLITE_DEFAULT_CACHE_SIZE and
86** SQLITE_DEFAULT_TEMP_CACHE_SIZE macros should be set.
drha1b351a2001-09-14 16:42:12 +000087*/
drh1ba1e6e2005-01-21 21:22:52 +000088#ifdef SQLITE_DEFAULT_CACHE_SIZE
89# define MAX_PAGES SQLITE_DEFAULT_CACHE_SIZE
90#else
91# define MAX_PAGES 2000
92#endif
danielk197724c8ab82005-02-09 01:40:23 +000093#ifdef SQLITE_DEFAULT_TEMP_CACHE_SIZE
94# define TEMP_PAGES SQLITE_DEFAULT_TEMP_CACHE_SIZE
95#else
96# define TEMP_PAGES 500
97#endif
drha1b351a2001-09-14 16:42:12 +000098
99/*
danielk197753c0f742005-03-29 03:10:59 +0000100** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
101** afterward. Having this macro allows us to cause the C compiler
102** to omit code used by TEMP tables without messy #ifndef statements.
103*/
104#ifdef SQLITE_OMIT_TEMPDB
105#define OMIT_TEMPDB 1
106#else
107#define OMIT_TEMPDB 0
108#endif
109
110/*
drh0bd1f4e2002-06-06 18:54:39 +0000111** If the following macro is set to 1, then NULL values are considered
112** distinct for the SELECT DISTINCT statement and for UNION or EXCEPT
113** compound queries. No other SQL database engine (among those tested)
114** works this way except for OCELOT. But the SQL92 spec implies that
115** this is how things should work.
116**
117** If the following macro is set to 0, then NULLs are indistinct for
118** SELECT DISTINCT and for UNION.
119*/
120#define NULL_ALWAYS_DISTINCT 0
121
122/*
123** If the following macro is set to 1, then NULL values are considered
124** distinct when determining whether or not two entries are the same
125** in a UNIQUE index. This is the way PostgreSQL, Oracle, DB2, MySQL,
126** OCELOT, and Firebird all work. The SQL92 spec explicitly says this
127** is the way things are suppose to work.
128**
129** If the following macro is set to 0, the NULLs are indistinct for
130** a UNIQUE index. In this mode, you can only have a single NULL entry
131** for a column declared UNIQUE. This is the way Informix and SQL Server
132** work.
133*/
134#define NULL_DISTINCT_FOR_UNIQUE 1
135
136/*
drh665de472003-03-31 13:36:09 +0000137** The maximum number of attached databases. This must be at least 2
138** in order to support the main database file (0) and the file used to
drh80242052004-06-09 00:48:12 +0000139** hold temporary tables (1). And it must be less than 32 because
140** we use a bitmask of databases with a u32 in places (for example
141** the Parse.cookieMask field).
drh665de472003-03-31 13:36:09 +0000142*/
143#define MAX_ATTACHED 10
144
145/*
drhfa6bc002004-09-07 16:19:52 +0000146** The maximum value of a ?nnn wildcard that the parser will accept.
147*/
148#define SQLITE_MAX_VARIABLE_NUMBER 999
149
150/*
drhd946db02005-12-29 19:23:06 +0000151** The "file format" number is an integer that is incremented whenever
152** the VDBE-level file format changes. The following macros define the
153** the default file format for new databases and the maximum file format
154** that the library can read.
155*/
156#define SQLITE_MAX_FILE_FORMAT 4
157#ifndef SQLITE_DEFAULT_FILE_FORMAT
158# define SQLITE_DEFAULT_FILE_FORMAT 4
159#endif
160
161/*
drh49766d62005-01-08 18:42:28 +0000162** Provide a default value for TEMP_STORE in case it is not specified
163** on the command-line
164*/
165#ifndef TEMP_STORE
166# define TEMP_STORE 1
167#endif
168
169/*
drhf1974842004-11-05 03:56:00 +0000170** GCC does not define the offsetof() macro so we'll have to do it
171** ourselves.
172*/
173#ifndef offsetof
174#define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
175#endif
176
177/*
drh5a2c2c22001-11-21 02:21:11 +0000178** Integers of known sizes. These typedefs might change for architectures
179** where the sizes very. Preprocessor macros are available so that the
180** types can be conveniently redefined at compile-type. Like this:
181**
182** cc '-DUINTPTR_TYPE=long long int' ...
drh41a2b482001-01-20 19:52:49 +0000183*/
drh3aac2dd2004-04-26 14:10:20 +0000184#ifndef UINT64_TYPE
drhefad9992004-06-22 12:13:55 +0000185# if defined(_MSC_VER) || defined(__BORLANDC__)
186# define UINT64_TYPE unsigned __int64
187# else
188# define UINT64_TYPE unsigned long long int
189# endif
drh3aac2dd2004-04-26 14:10:20 +0000190#endif
drh5a2c2c22001-11-21 02:21:11 +0000191#ifndef UINT32_TYPE
192# define UINT32_TYPE unsigned int
193#endif
194#ifndef UINT16_TYPE
195# define UINT16_TYPE unsigned short int
196#endif
drh939a16d2004-07-15 13:37:22 +0000197#ifndef INT16_TYPE
198# define INT16_TYPE short int
199#endif
drh5a2c2c22001-11-21 02:21:11 +0000200#ifndef UINT8_TYPE
201# define UINT8_TYPE unsigned char
202#endif
drh905793e2004-02-21 13:31:09 +0000203#ifndef INT8_TYPE
204# define INT8_TYPE signed char
205#endif
drhefad9992004-06-22 12:13:55 +0000206#ifndef LONGDOUBLE_TYPE
207# define LONGDOUBLE_TYPE long double
208#endif
drhefad9992004-06-22 12:13:55 +0000209typedef sqlite_int64 i64; /* 8-byte signed integer */
drh3aac2dd2004-04-26 14:10:20 +0000210typedef UINT64_TYPE u64; /* 8-byte unsigned integer */
drh5a2c2c22001-11-21 02:21:11 +0000211typedef UINT32_TYPE u32; /* 4-byte unsigned integer */
212typedef UINT16_TYPE u16; /* 2-byte unsigned integer */
drh939a16d2004-07-15 13:37:22 +0000213typedef INT16_TYPE i16; /* 2-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000214typedef UINT8_TYPE u8; /* 1-byte unsigned integer */
drh905793e2004-02-21 13:31:09 +0000215typedef UINT8_TYPE i8; /* 1-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000216
217/*
drhbbd42a62004-05-22 17:41:58 +0000218** Macros to determine whether the machine is big or little endian,
219** evaluated at runtime.
220*/
221extern const int sqlite3one;
drh9c054832004-05-31 18:51:57 +0000222#define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0)
223#define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
drhbbd42a62004-05-22 17:41:58 +0000224
225/*
drh90f5ecb2004-07-22 01:19:35 +0000226** An instance of the following structure is used to store the busy-handler
227** callback for a given sqlite handle.
228**
229** The sqlite.busyHandler member of the sqlite struct contains the busy
230** callback for the database handle. Each pager opened via the sqlite
231** handle is passed a pointer to sqlite.busyHandler. The busy-handler
232** callback is currently invoked only from within pager.c.
233*/
234typedef struct BusyHandler BusyHandler;
235struct BusyHandler {
236 int (*xFunc)(void *,int); /* The busy callback */
237 void *pArg; /* First arg to busy callback */
drha4afb652005-07-09 02:16:02 +0000238 int nBusy; /* Incremented with each busy call */
drh90f5ecb2004-07-22 01:19:35 +0000239};
240
241/*
242** Defer sourcing vdbe.h and btree.h until after the "u8" and
243** "BusyHandler typedefs.
drh905793e2004-02-21 13:31:09 +0000244*/
245#include "vdbe.h"
drh3aac2dd2004-04-26 14:10:20 +0000246#include "btree.h"
danielk197713f72992005-12-18 08:51:22 +0000247#include "pager.h"
drh905793e2004-02-21 13:31:09 +0000248
249/*
drh5a2c2c22001-11-21 02:21:11 +0000250** This macro casts a pointer to an integer. Useful for doing
251** pointer arithmetic.
252*/
253#define Addr(X) ((uptr)X)
drh41a2b482001-01-20 19:52:49 +0000254
danielk19772c336542005-01-13 02:14:23 +0000255#ifdef SQLITE_MEMDEBUG
drh75897232000-05-29 14:26:00 +0000256/*
drh6e142f52000-06-08 13:36:40 +0000257** The following global variables are used for testing and debugging
danielk1977c00da102006-01-07 13:21:04 +0000258** only. They only work if SQLITE_MEMDEBUG is defined.
drh6e142f52000-06-08 13:36:40 +0000259*/
drh46934232004-11-20 19:18:00 +0000260extern int sqlite3_nMalloc; /* Number of sqliteMalloc() calls */
261extern int sqlite3_nFree; /* Number of sqliteFree() calls */
262extern int sqlite3_iMallocFail; /* Fail sqliteMalloc() after this many calls */
263extern int sqlite3_iMallocReset; /* Set iMallocFail to this when it reaches 0 */
danielk19772e588c72005-12-09 14:25:08 +0000264#define ENTER_MALLOC (\
danielk1977e501b892006-01-09 06:29:47 +0000265 sqlite3ThreadData()->zFile = __FILE__, sqlite3ThreadData()->iLine = __LINE__ \
danielk19772e588c72005-12-09 14:25:08 +0000266)
danielk1977c00da102006-01-07 13:21:04 +0000267#define sqliteMalloc(x) (ENTER_MALLOC, sqlite3Malloc(x))
268#define sqliteMallocRaw(x) (ENTER_MALLOC, sqlite3MallocRaw(x))
269#define sqliteRealloc(x,y) (ENTER_MALLOC, sqlite3Realloc(x,y))
270#define sqliteStrDup(x) (ENTER_MALLOC, sqlite3StrDup(x))
271#define sqliteStrNDup(x,y) (ENTER_MALLOC, sqlite3StrNDup(x,y))
272#define sqliteReallocOrFree(x,y) (ENTER_MALLOC, sqlite3ReallocOrFree(x,y))
danielk19772e588c72005-12-09 14:25:08 +0000273
danielk197797cb2e92005-12-09 14:39:04 +0000274#else
275
danielk1977c00da102006-01-07 13:21:04 +0000276#define sqliteMalloc(x) sqlite3Malloc(x)
277#define sqliteMallocRaw(x) sqlite3MallocRaw(x)
278#define sqliteRealloc(x,y) sqlite3Realloc(x,y)
279#define sqliteStrDup(x) sqlite3StrDup(x)
280#define sqliteStrNDup(x,y) sqlite3StrNDup(x,y)
281#define sqliteReallocOrFree(x,y) sqlite3ReallocOrFree(x,y)
danielk197797cb2e92005-12-09 14:39:04 +0000282
283#endif
284
danielk197713f72992005-12-18 08:51:22 +0000285#define sqliteFree(x) sqlite3FreeX(x)
286#define sqliteAllocSize(x) sqlite3AllocSize(x)
danielk197797cb2e92005-12-09 14:39:04 +0000287
danielk19772e588c72005-12-09 14:25:08 +0000288/*
drh6f7adc82006-01-11 21:41:20 +0000289** An instance of this structure might be allocated to store information
290** specific to a single thread.
291**
292** To avoid a memory leak on windows, the content of this structure is
293** checked at the conclusion of each API call. If it is all zero, it
294** is deallocated.
danielk19772e588c72005-12-09 14:25:08 +0000295*/
danielk1977e501b892006-01-09 06:29:47 +0000296struct ThreadData {
drh70ff98a2006-01-12 01:25:18 +0000297 int mallocFailed; /* True after a malloc() has failed */
298 int nRef; /* Number of users */
danielk19775591df52005-12-20 09:19:37 +0000299
drh6f7adc82006-01-11 21:41:20 +0000300#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drhd2d4a6b2006-01-10 15:18:27 +0000301 int nSoftHeapLimit; /* Suggested max mem allocation. No limit if <0 */
302 int nAlloc; /* Number of bytes currently allocated */
danielk19775591df52005-12-20 09:19:37 +0000303 Pager *pPager; /* Linked list of all pagers in this thread */
danielk19777ddad962005-12-12 06:53:03 +0000304#endif
305
danielk1977aef0bf62005-12-30 16:28:01 +0000306#ifndef SQLITE_OMIT_SHARED_CACHE
307 u8 useSharedData; /* True if shared pagers and schemas are enabled */
drhd78901d2006-01-05 23:42:50 +0000308 BtShared *pBtree; /* Linked list of all currently open BTrees */
danielk1977aef0bf62005-12-30 16:28:01 +0000309#endif
310
danielk19772e588c72005-12-09 14:25:08 +0000311#ifdef SQLITE_MEMDEBUG
drhd2d4a6b2006-01-10 15:18:27 +0000312 int nMaxAlloc; /* High water mark of ThreadData.nAlloc */
drh6f7adc82006-01-11 21:41:20 +0000313 int mallocDisallowed; /* assert() in sqlite3Malloc() if set */
danielk19772e588c72005-12-09 14:25:08 +0000314 int isFail; /* True if all malloc() calls should fail */
315 const char *zFile; /* Filename to associate debugging info with */
316 int iLine; /* Line number to associate debugging info with */
317 void *pFirst; /* Pointer to linked list of allocations */
318#endif
319};
320
drh6e142f52000-06-08 13:36:40 +0000321/*
drh75897232000-05-29 14:26:00 +0000322** Name of the master database table. The master database table
323** is a special table that holds the names and attributes of all
324** user tables and indices.
325*/
drhe0bc4042002-06-25 01:09:11 +0000326#define MASTER_NAME "sqlite_master"
327#define TEMP_MASTER_NAME "sqlite_temp_master"
drh75897232000-05-29 14:26:00 +0000328
329/*
danielk19778e150812004-05-10 01:17:37 +0000330** The root-page of the master database table.
331*/
332#define MASTER_ROOT 1
333
334/*
drhed6c8672003-01-12 18:02:16 +0000335** The name of the schema table.
336*/
danielk197753c0f742005-03-29 03:10:59 +0000337#define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
drhed6c8672003-01-12 18:02:16 +0000338
339/*
drh75897232000-05-29 14:26:00 +0000340** A convenience macro that returns the number of elements in
341** an array.
342*/
343#define ArraySize(X) (sizeof(X)/sizeof(X[0]))
344
345/*
346** Forward references to structures
347*/
drh13449892005-09-07 21:22:45 +0000348typedef struct AggInfo AggInfo;
drhfe05af82005-07-21 03:14:59 +0000349typedef struct AuthContext AuthContext;
350typedef struct CollSeq CollSeq;
drh7020f652000-06-03 18:06:52 +0000351typedef struct Column Column;
drhfe05af82005-07-21 03:14:59 +0000352typedef struct Db Db;
danielk1977e501b892006-01-09 06:29:47 +0000353typedef struct Schema Schema;
drh75897232000-05-29 14:26:00 +0000354typedef struct Expr Expr;
355typedef struct ExprList ExprList;
drhc2eef3b2002-08-31 18:53:06 +0000356typedef struct FKey FKey;
drhfe05af82005-07-21 03:14:59 +0000357typedef struct FuncDef FuncDef;
358typedef struct IdList IdList;
359typedef struct Index Index;
danielk19778d059842004-05-12 11:24:02 +0000360typedef struct KeyClass KeyClass;
drhd3d39e92004-05-20 22:16:29 +0000361typedef struct KeyInfo KeyInfo;
drh626a8792005-01-17 22:08:19 +0000362typedef struct NameContext NameContext;
drhfe05af82005-07-21 03:14:59 +0000363typedef struct Parse Parse;
364typedef struct Select Select;
365typedef struct SrcList SrcList;
danielk1977e501b892006-01-09 06:29:47 +0000366typedef struct ThreadData ThreadData;
drhfe05af82005-07-21 03:14:59 +0000367typedef struct Table Table;
danielk1977c00da102006-01-07 13:21:04 +0000368typedef struct TableLock TableLock;
drhfe05af82005-07-21 03:14:59 +0000369typedef struct Token Token;
370typedef struct TriggerStack TriggerStack;
371typedef struct TriggerStep TriggerStep;
372typedef struct Trigger Trigger;
drhfe05af82005-07-21 03:14:59 +0000373typedef struct WhereInfo WhereInfo;
374typedef struct WhereLevel WhereLevel;
drhd3d39e92004-05-20 22:16:29 +0000375
drh001bbcb2003-03-19 03:14:00 +0000376/*
377** Each database file to be accessed by the system is an instance
378** of the following structure. There are normally two of these structures
379** in the sqlite.aDb[] array. aDb[0] is the main database file and
drha69d9162003-04-17 22:57:53 +0000380** aDb[1] is the database file used to hold temporary tables. Additional
381** databases may be attached.
drh001bbcb2003-03-19 03:14:00 +0000382*/
383struct Db {
384 char *zName; /* Name of this database */
385 Btree *pBt; /* The B*Tree structure for this database file */
danielk1977da184232006-01-05 11:34:32 +0000386 u8 inTrans; /* 0: not writable. 1: Transaction. 2: Checkpoint */
387 u8 safety_level; /* How aggressive at synching data to disk */
danielk1977da184232006-01-05 11:34:32 +0000388 void *pAux; /* Auxiliary data. Usually NULL */
389 void (*xFreeAux)(void*); /* Routine to free pAux */
danielk1977e501b892006-01-09 06:29:47 +0000390 Schema *pSchema; /* Pointer to database schema (possibly shared) */
danielk1977da184232006-01-05 11:34:32 +0000391};
392
393/*
394** An instance of the following structure stores a database schema.
395*/
danielk1977e501b892006-01-09 06:29:47 +0000396struct Schema {
drh001bbcb2003-03-19 03:14:00 +0000397 int schema_cookie; /* Database schema version number for this file */
drhd24cc422003-03-27 12:51:24 +0000398 Hash tblHash; /* All tables indexed by name */
399 Hash idxHash; /* All (named) indices indexed by name */
400 Hash trigHash; /* All triggers indexed by name */
401 Hash aFKey; /* Foreign keys indexed by to-table */
drh4794f732004-11-05 17:17:50 +0000402 Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */
danielk1977da184232006-01-05 11:34:32 +0000403 u8 file_format; /* Schema format version for this file */
404 u16 flags; /* Flags associated with this schema */
danielk197714db2662006-01-09 16:12:04 +0000405 int cache_size; /* Number of pages to use in the cache */
406 u8 enc; /* Text encoding used by this database */
drh001bbcb2003-03-19 03:14:00 +0000407};
drh75897232000-05-29 14:26:00 +0000408
409/*
drh8bf8dc92003-05-17 17:35:10 +0000410** These macros can be used to test, set, or clear bits in the
411** Db.flags field.
412*/
danielk1977da184232006-01-05 11:34:32 +0000413#define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))==(P))
414#define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))!=0)
415#define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->flags|=(P)
416#define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->flags&=~(P)
drh8bf8dc92003-05-17 17:35:10 +0000417
418/*
419** Allowed values for the DB.flags field.
420**
drh8bf8dc92003-05-17 17:35:10 +0000421** The DB_SchemaLoaded flag is set after the database schema has been
422** read into internal hash tables.
423**
424** DB_UnresetViews means that one or more views have column names that
425** have been filled out. If the schema changes, these column names might
426** changes and so the view will need to be reset.
427*/
drh124b27e2004-06-19 16:06:10 +0000428#define DB_SchemaLoaded 0x0001 /* The schema has been loaded */
429#define DB_UnresetViews 0x0002 /* Some views have defined column names */
danielk1977b82e7ed2006-01-11 14:09:31 +0000430#define DB_Empty 0x0004 /* The file is empty (length 0 bytes) */
drh8bf8dc92003-05-17 17:35:10 +0000431
danielk1977dc8453f2004-06-12 00:42:34 +0000432#define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
drh8bf8dc92003-05-17 17:35:10 +0000433
434/*
drhc9b84a12002-06-20 11:36:48 +0000435** Each database is an instance of the following structure.
436**
rdcb0c374f2004-02-20 22:53:38 +0000437** The sqlite.lastRowid records the last insert rowid generated by an
438** insert statement. Inserts on views do not affect its value. Each
439** trigger has its own context, so that lastRowid can be updated inside
440** triggers as usual. The previous value will be restored once the trigger
441** exits. Upon entering a before or instead of trigger, lastRowid is no
442** longer (since after version 2.8.12) reset to -1.
443**
444** The sqlite.nChange does not count changes within triggers and keeps no
danielk19776f8a5032004-05-10 10:34:51 +0000445** context. It is reset at start of sqlite3_exec.
rdcb0c374f2004-02-20 22:53:38 +0000446** The sqlite.lsChange represents the number of changes made by the last
447** insert, update, or delete statement. It remains constant throughout the
448** length of a statement and is then updated by OP_SetCounts. It keeps a
449** context stack just like lastRowid so that the count of changes
450** within a trigger is not seen outside the trigger. Changes to views do not
451** affect the value of lsChange.
452** The sqlite.csChange keeps track of the number of current changes (since
453** the last statement) and is used to update sqlite_lsChange.
danielk19776622cce2004-05-20 11:00:52 +0000454**
455** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
456** store the most recent error code and, if applicable, string. The
457** internal function sqlite3Error() is used to set these variables
458** consistently.
drh75897232000-05-29 14:26:00 +0000459*/
drh9bb575f2004-09-06 17:24:11 +0000460struct sqlite3 {
drh001bbcb2003-03-19 03:14:00 +0000461 int nDb; /* Number of backends currently in use */
462 Db *aDb; /* All backends */
drh5e00f6c2001-09-13 13:46:56 +0000463 int flags; /* Miscellanous flags. See below */
drhfcd35c72005-05-21 02:48:08 +0000464 int errCode; /* Most recent error code (SQLITE_*) */
drhfcd35c72005-05-21 02:48:08 +0000465 u8 autoCommit; /* The auto-commit flag. */
drh90f5ecb2004-07-22 01:19:35 +0000466 u8 temp_store; /* 1: file 2: memory 0: default */
drh5e00f6c2001-09-13 13:46:56 +0000467 int nTable; /* Number of tables in the database */
drhd3d39e92004-05-20 22:16:29 +0000468 CollSeq *pDfltColl; /* The default collating sequence (BINARY) */
drhf328bc82004-05-10 23:29:49 +0000469 i64 lastRowid; /* ROWID of most recent insert (see above) */
470 i64 priorNewRowid; /* Last randomly generated ROWID */
drh247be432002-05-10 05:44:55 +0000471 int magic; /* Magic number for detect library misuse */
danielk1977b28af712004-06-21 06:50:26 +0000472 int nChange; /* Value returned by sqlite3_changes() */
473 int nTotalChange; /* Value returned by sqlite3_total_changes() */
474 struct sqlite3InitInfo { /* Information used during initialization */
475 int iDb; /* When back is being initialized */
476 int newTnum; /* Rootpage of table being initialized */
477 u8 busy; /* TRUE if currently initializing */
drh1d85d932004-02-14 23:05:52 +0000478 } init;
drh326dce72003-01-29 14:06:07 +0000479 struct Vdbe *pVdbe; /* List of active virtual machines */
danielk19771d850a72004-05-31 08:26:49 +0000480 int activeVdbeCnt; /* Number of vdbes currently executing */
drh19e2d372005-08-29 23:00:03 +0000481 void (*xTrace)(void*,const char*); /* Trace function */
482 void *pTraceArg; /* Argument to the trace function */
483 void (*xProfile)(void*,const char*,u64); /* Profiling function */
484 void *pProfileArg; /* Argument to profile function */
danielk197771fd80b2005-12-16 06:54:01 +0000485 void *pCommitArg; /* Argument to xCommitCallback() */
486 int (*xCommitCallback)(void*); /* Invoked at every commit. */
487 void *pRollbackArg; /* Argument to xRollbackCallback() */
488 void (*xRollbackCallback)(void*); /* Invoked at every commit. */
danielk197794eb6a12005-12-15 15:22:08 +0000489 void *pUpdateArg;
490 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
drhfcd35c72005-05-21 02:48:08 +0000491 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
492 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
493 void *pCollNeededArg;
drhfcd35c72005-05-21 02:48:08 +0000494 sqlite3_value *pErr; /* Most recent error message */
495 char *zErrMsg; /* Most recent error message (UTF-8 encoded) */
496 char *zErrMsg16; /* Most recent error message (UTF-16 encoded) */
drhed6c8672003-01-12 18:02:16 +0000497#ifndef SQLITE_OMIT_AUTHORIZATION
drhe22a3342003-04-22 20:30:37 +0000498 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
499 /* Access authorization function */
drhed6c8672003-01-12 18:02:16 +0000500 void *pAuthArg; /* 1st argument to the access auth function */
501#endif
danielk1977348bb5d2003-10-18 09:37:26 +0000502#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
503 int (*xProgress)(void *); /* The progress callback */
504 void *pProgressArg; /* Argument to the progress callback */
505 int nProgressOps; /* Number of opcodes for progress callback */
506#endif
danielk19776b456a22005-03-21 04:04:02 +0000507#ifndef SQLITE_OMIT_GLOBALRECOVER
508 sqlite3 *pNext; /* Linked list of open db handles. */
509#endif
drhfcd35c72005-05-21 02:48:08 +0000510 Hash aFunc; /* All functions that can be in SQL exprs */
511 Hash aCollSeq; /* All collating sequences */
512 BusyHandler busyHandler; /* Busy callback */
drh97903fe2005-05-24 20:19:57 +0000513 int busyTimeout; /* Busy handler timeout, in msec */
drhfcd35c72005-05-21 02:48:08 +0000514 Db aDbStatic[2]; /* Static space for the 2 default backends */
danielk19777e900ab2005-05-23 04:51:01 +0000515#ifdef SQLITE_SSE
516 sqlite3_stmt *pFetch; /* Used by SSE to fetch stored statements */
517#endif
drh75897232000-05-29 14:26:00 +0000518};
519
danielk197714db2662006-01-09 16:12:04 +0000520#define ENC(db) ((db)->aDb[0].pSchema->enc)
521
drh75897232000-05-29 14:26:00 +0000522/*
drh8bf8dc92003-05-17 17:35:10 +0000523** Possible values for the sqlite.flags and or Db.flags fields.
524**
525** On sqlite.flags, the SQLITE_InTrans value means that we have
526** executed a BEGIN. On Db.flags, SQLITE_InTrans means a statement
527** transaction is active on that particular database file.
drh75897232000-05-29 14:26:00 +0000528*/
drh5e00f6c2001-09-13 13:46:56 +0000529#define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */
drh5e00f6c2001-09-13 13:46:56 +0000530#define SQLITE_Interrupt 0x00000004 /* Cancel current operation */
531#define SQLITE_InTrans 0x00000008 /* True if in a transaction */
532#define SQLITE_InternChanges 0x00000010 /* Uncommitted Hash table changes */
drh382c0242001-10-06 16:33:02 +0000533#define SQLITE_FullColNames 0x00000020 /* Show full column names on SELECT */
drhfcabd462004-02-20 14:50:58 +0000534#define SQLITE_ShortColNames 0x00000040 /* Show short columns names */
535#define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */
drh1bee3d72001-10-15 00:44:35 +0000536 /* DELETE, or UPDATE and return */
537 /* the count using a callback. */
drhfcabd462004-02-20 14:50:58 +0000538#define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */
drh6a535342001-10-19 16:44:56 +0000539 /* result set is empty */
drh35d4c2f2004-06-10 01:30:59 +0000540#define SQLITE_SqlTrace 0x00000200 /* Debug print SQL as it executes */
541#define SQLITE_VdbeListing 0x00000400 /* Debug listings of VDBE programs */
drhf4040832004-10-22 20:29:21 +0000542#define SQLITE_WriteSchema 0x00000800 /* OK to update SQLITE_MASTER */
drh7bec5052005-02-06 02:45:41 +0000543#define SQLITE_NoReadlock 0x00001000 /* Readlocks are omitted when
544 ** accessing read-only databases */
drh0cd2d4c2005-11-03 02:15:02 +0000545#define SQLITE_IgnoreChecks 0x00002000 /* Do not enforce check constraints */
danielk1977da184232006-01-05 11:34:32 +0000546#define SQLITE_ReadUncommitted 0x00004000 /* For shared-cache mode */
drhe321c292006-01-12 01:56:43 +0000547#define SQLITE_LegacyFileFmt 0x00008000 /* Create new databases in format 1 */
drh58b95762000-06-02 01:17:37 +0000548
549/*
drh247be432002-05-10 05:44:55 +0000550** Possible values for the sqlite.magic field.
551** The numbers are obtained at random and have no special meaning, other
552** than being distinct from one another.
553*/
554#define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */
555#define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */
556#define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */
557#define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */
558
559/*
drh0bce8352002-02-28 00:41:10 +0000560** Each SQL function is defined by an instance of the following
561** structure. A pointer to this structure is stored in the sqlite.aFunc
drh8e0a2f92002-02-23 23:45:45 +0000562** hash table. When multiple functions have the same name, the hash table
563** points to a linked list of these structures.
drh28037572000-08-02 13:47:41 +0000564*/
drh0bce8352002-02-28 00:41:10 +0000565struct FuncDef {
drh55ef4d92005-08-14 01:20:37 +0000566 i16 nArg; /* Number of arguments. -1 means unlimited */
danielk1977d8123362004-06-12 09:25:12 +0000567 u8 iPrefEnc; /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
drh55ef4d92005-08-14 01:20:37 +0000568 u8 needCollSeq; /* True if sqlite3GetFuncCollSeq() might be called */
569 u8 flags; /* Some combination of SQLITE_FUNC_* */
drhf9b596e2004-05-26 16:54:42 +0000570 void *pUserData; /* User data parameter */
571 FuncDef *pNext; /* Next function with same name */
572 void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
573 void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
574 void (*xFinalize)(sqlite3_context*); /* Aggregate finializer */
drh55ef4d92005-08-14 01:20:37 +0000575 char zName[1]; /* SQL name of the function. MUST BE LAST */
drh8e0a2f92002-02-23 23:45:45 +0000576};
drh28037572000-08-02 13:47:41 +0000577
578/*
drh55ef4d92005-08-14 01:20:37 +0000579** Possible values for FuncDef.flags
580*/
drhd64fe2f2005-08-28 17:00:23 +0000581#define SQLITE_FUNC_LIKE 0x01 /* Candidate for the LIKE optimization */
582#define SQLITE_FUNC_CASE 0x02 /* Case-sensitive LIKE-type function */
drh55ef4d92005-08-14 01:20:37 +0000583
584/*
drh967e8b72000-06-21 13:59:10 +0000585** information about each column of an SQL table is held in an instance
drh7020f652000-06-03 18:06:52 +0000586** of this structure.
587*/
588struct Column {
drh967e8b72000-06-21 13:59:10 +0000589 char *zName; /* Name of this column */
danielk19777977a172004-11-09 12:44:37 +0000590 Expr *pDflt; /* Default value of this column */
drh382c0242001-10-06 16:33:02 +0000591 char *zType; /* Data type for this column */
danielk1977b3bf5562006-01-10 17:58:23 +0000592 char *zColl; /* Collating sequence. If NULL, use the default */
drh4a324312001-12-21 14:30:42 +0000593 u8 notNull; /* True if there is a NOT NULL constraint */
drh78100cc2003-08-23 22:40:53 +0000594 u8 isPrimKey; /* True if this column is part of the PRIMARY KEY */
danielk1977a37cdde2004-05-16 11:15:36 +0000595 char affinity; /* One of the SQLITE_AFF_... values */
drh7020f652000-06-03 18:06:52 +0000596};
597
598/*
drha9fd84b2004-05-18 23:21:35 +0000599** A "Collating Sequence" is defined by an instance of the following
danielk19770202b292004-06-09 09:55:16 +0000600** structure. Conceptually, a collating sequence consists of a name and
601** a comparison routine that defines the order of that sequence.
drha9fd84b2004-05-18 23:21:35 +0000602**
danielk19770202b292004-06-09 09:55:16 +0000603** There may two seperate implementations of the collation function, one
604** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
605** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
606** native byte order. When a collation sequence is invoked, SQLite selects
607** the version that will require the least expensive encoding
danielk1977b3bf5562006-01-10 17:58:23 +0000608** translations, if any.
danielk19770202b292004-06-09 09:55:16 +0000609**
610** The CollSeq.pUser member variable is an extra parameter that passed in
611** as the first argument to the UTF-8 comparison function, xCmp.
612** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
613** xCmp16.
614**
615** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
616** collating sequence is undefined. Indices built on an undefined
617** collating sequence may not be read or written.
drha9fd84b2004-05-18 23:21:35 +0000618*/
619struct CollSeq {
danielk19770202b292004-06-09 09:55:16 +0000620 char *zName; /* Name of the collating sequence, UTF-8 encoded */
danielk1977466be562004-06-10 02:16:01 +0000621 u8 enc; /* Text encoding handled by xCmp() */
drhd64fe2f2005-08-28 17:00:23 +0000622 u8 type; /* One of the SQLITE_COLL_... values below */
drha9fd84b2004-05-18 23:21:35 +0000623 void *pUser; /* First argument to xCmp() */
danielk19770202b292004-06-09 09:55:16 +0000624 int (*xCmp)(void*,int, const void*, int, const void*);
drha9fd84b2004-05-18 23:21:35 +0000625};
626
627/*
drhd64fe2f2005-08-28 17:00:23 +0000628** Allowed values of CollSeq flags:
629*/
630#define SQLITE_COLL_BINARY 1 /* The default memcmp() collating sequence */
631#define SQLITE_COLL_NOCASE 2 /* The built-in NOCASE collating sequence */
632#define SQLITE_COLL_REVERSE 3 /* The built-in REVERSE collating sequence */
633#define SQLITE_COLL_USER 0 /* Any other user-defined collating sequence */
634
635/*
drhd3d39e92004-05-20 22:16:29 +0000636** A sort order can be either ASC or DESC.
drh8e2ca022002-06-17 17:07:19 +0000637*/
drh8e2ca022002-06-17 17:07:19 +0000638#define SQLITE_SO_ASC 0 /* Sort in ascending order */
drhd3d39e92004-05-20 22:16:29 +0000639#define SQLITE_SO_DESC 1 /* Sort in ascending order */
drh8e2ca022002-06-17 17:07:19 +0000640
641/*
danielk1977a37cdde2004-05-16 11:15:36 +0000642** Column affinity types.
drh8a512562005-11-14 22:29:05 +0000643**
644** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
645** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve
646** the speed a little by number the values consecutively.
647**
648** But rather than start with 0 or 1, we begin with 'a'. That way,
649** when multiple affinity types are concatenated into a string and
650** used as the P3 operand, they will be more readable.
651**
652** Note also that the numeric types are grouped together so that testing
653** for a numeric type is a single comparison.
danielk1977a37cdde2004-05-16 11:15:36 +0000654*/
drh8a512562005-11-14 22:29:05 +0000655#define SQLITE_AFF_TEXT 'a'
656#define SQLITE_AFF_NONE 'b'
657#define SQLITE_AFF_NUMERIC 'c'
658#define SQLITE_AFF_INTEGER 'd'
659#define SQLITE_AFF_REAL 'e'
danielk1977a37cdde2004-05-16 11:15:36 +0000660
drh8a512562005-11-14 22:29:05 +0000661#define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC)
danielk1977a37cdde2004-05-16 11:15:36 +0000662
663/*
drh22f70c32002-02-18 01:17:00 +0000664** Each SQL table is represented in memory by an instance of the
665** following structure.
666**
drhd24cc422003-03-27 12:51:24 +0000667** Table.zName is the name of the table. The case of the original
drh22f70c32002-02-18 01:17:00 +0000668** CREATE TABLE statement is stored, but case is not significant for
669** comparisons.
670**
drhd24cc422003-03-27 12:51:24 +0000671** Table.nCol is the number of columns in this table. Table.aCol is a
drh22f70c32002-02-18 01:17:00 +0000672** pointer to an array of Column structures, one for each column.
673**
drhd24cc422003-03-27 12:51:24 +0000674** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
675** the column that is that key. Otherwise Table.iPKey is negative. Note
drh22f70c32002-02-18 01:17:00 +0000676** that the datatype of the PRIMARY KEY must be INTEGER for this field to
677** be set. An INTEGER PRIMARY KEY is used as the rowid for each row of
678** the table. If a table has no INTEGER PRIMARY KEY, then a random rowid
drhd24cc422003-03-27 12:51:24 +0000679** is generated for each row of the table. Table.hasPrimKey is true if
drh22f70c32002-02-18 01:17:00 +0000680** the table has any PRIMARY KEY, INTEGER or otherwise.
681**
drhd24cc422003-03-27 12:51:24 +0000682** Table.tnum is the page number for the root BTree page of the table in the
683** database file. If Table.iDb is the index of the database table backend
684** in sqlite.aDb[]. 0 is for the main database and 1 is for the file that
685** holds temporary tables and indices. If Table.isTransient
drh22f70c32002-02-18 01:17:00 +0000686** is true, then the table is stored in a file that is automatically deleted
drhd24cc422003-03-27 12:51:24 +0000687** when the VDBE cursor to the table is closed. In this case Table.tnum
drh22f70c32002-02-18 01:17:00 +0000688** refers VDBE cursor number that holds the table open, not to the root
689** page number. Transient tables are used to hold the results of a
690** sub-query that appears instead of a real table name in the FROM clause
691** of a SELECT statement.
drh75897232000-05-29 14:26:00 +0000692*/
693struct Table {
drh967e8b72000-06-21 13:59:10 +0000694 char *zName; /* Name of the table */
drh967e8b72000-06-21 13:59:10 +0000695 int nCol; /* Number of columns in this table */
696 Column *aCol; /* Information about each column */
drhc8392582001-12-31 02:48:51 +0000697 int iPKey; /* If not less then 0, use aCol[iPKey] as the primary key */
drh967e8b72000-06-21 13:59:10 +0000698 Index *pIndex; /* List of SQL indexes on this table. */
drh22f70c32002-02-18 01:17:00 +0000699 int tnum; /* Root BTree node for this table (see note above) */
drha76b5df2002-02-23 02:32:10 +0000700 Select *pSelect; /* NULL for tables. Points to definition if a view. */
drh717e6402001-09-27 03:22:32 +0000701 u8 readOnly; /* True if this table should not be written by the user */
drhd2d4a6b2006-01-10 15:18:27 +0000702// u8 iDb; /* Index into sqlite.aDb[] of the backend for this table */
drh22f70c32002-02-18 01:17:00 +0000703 u8 isTransient; /* True if automatically deleted when VDBE finishes */
drh4a324312001-12-21 14:30:42 +0000704 u8 hasPrimKey; /* True if there exists a primary key */
drh9cfcf5d2002-01-29 18:41:24 +0000705 u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */
drh205f48e2004-11-05 00:43:11 +0000706 u8 autoInc; /* True if the integer primary key is autoincrement */
drhed8a3bb2005-06-06 21:19:56 +0000707 int nRef; /* Number of pointers to this Table */
danielk1977c3f9bad2002-05-15 08:30:12 +0000708 Trigger *pTrigger; /* List of SQL triggers on this table */
drhc2eef3b2002-08-31 18:53:06 +0000709 FKey *pFKey; /* Linked list of all foreign keys in this table */
danielk19773d1bfea2004-05-14 11:00:53 +0000710 char *zColAff; /* String defining the affinity of each column */
drhffe07b22005-11-03 00:41:17 +0000711#ifndef SQLITE_OMIT_CHECK
712 Expr *pCheck; /* The AND of all CHECK constraints */
713#endif
danielk197719a8e7e2005-03-17 05:03:38 +0000714#ifndef SQLITE_OMIT_ALTERTABLE
715 int addColOffset; /* Offset in CREATE TABLE statement to add a new column */
716#endif
danielk1977e501b892006-01-09 06:29:47 +0000717 Schema *pSchema;
drh75897232000-05-29 14:26:00 +0000718};
719
720/*
drhc2eef3b2002-08-31 18:53:06 +0000721** Each foreign key constraint is an instance of the following structure.
722**
723** A foreign key is associated with two tables. The "from" table is
724** the table that contains the REFERENCES clause that creates the foreign
725** key. The "to" table is the table that is named in the REFERENCES clause.
726** Consider this example:
727**
728** CREATE TABLE ex1(
729** a INTEGER PRIMARY KEY,
730** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
731** );
732**
733** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
734**
735** Each REFERENCES clause generates an instance of the following structure
736** which is attached to the from-table. The to-table need not exist when
737** the from-table is created. The existance of the to-table is not checked
738** until an attempt is made to insert data into the from-table.
739**
drhea1ba172003-04-20 00:00:23 +0000740** The sqlite.aFKey hash table stores pointers to this structure
drhc2eef3b2002-08-31 18:53:06 +0000741** given the name of a to-table. For each to-table, all foreign keys
742** associated with that table are on a linked list using the FKey.pNextTo
743** field.
744*/
745struct FKey {
746 Table *pFrom; /* The table that constains the REFERENCES clause */
747 FKey *pNextFrom; /* Next foreign key in pFrom */
748 char *zTo; /* Name of table that the key points to */
749 FKey *pNextTo; /* Next foreign key that points to zTo */
750 int nCol; /* Number of columns in this key */
751 struct sColMap { /* Mapping of columns in pFrom to columns in zTo */
752 int iFrom; /* Index of column in pFrom */
753 char *zCol; /* Name of column in zTo. If 0 use PRIMARY KEY */
754 } *aCol; /* One entry for each of nCol column s */
755 u8 isDeferred; /* True if constraint checking is deferred till COMMIT */
756 u8 updateConf; /* How to resolve conflicts that occur on UPDATE */
757 u8 deleteConf; /* How to resolve conflicts that occur on DELETE */
758 u8 insertConf; /* How to resolve conflicts that occur on INSERT */
759};
760
761/*
762** SQLite supports many different ways to resolve a contraint
drh22f70c32002-02-18 01:17:00 +0000763** error. ROLLBACK processing means that a constraint violation
drh0bd1f4e2002-06-06 18:54:39 +0000764** causes the operation in process to fail and for the current transaction
drh1c928532002-01-31 15:54:21 +0000765** to be rolled back. ABORT processing means the operation in process
766** fails and any prior changes from that one operation are backed out,
767** but the transaction is not rolled back. FAIL processing means that
768** the operation in progress stops and returns an error code. But prior
769** changes due to the same operation are not backed out and no rollback
770** occurs. IGNORE means that the particular row that caused the constraint
771** error is not inserted or updated. Processing continues and no error
772** is returned. REPLACE means that preexisting database rows that caused
773** a UNIQUE constraint violation are removed so that the new insert or
774** update can proceed. Processing continues and no error is reported.
drhc2eef3b2002-08-31 18:53:06 +0000775**
776** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
777** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
778** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign
779** key is set to NULL. CASCADE means that a DELETE or UPDATE of the
780** referenced table row is propagated into the row that holds the
781** foreign key.
drh1c928532002-01-31 15:54:21 +0000782**
drh968af522003-02-11 14:55:40 +0000783** The following symbolic values are used to record which type
drh1c928532002-01-31 15:54:21 +0000784** of action to take.
drh9cfcf5d2002-01-29 18:41:24 +0000785*/
drh1c928532002-01-31 15:54:21 +0000786#define OE_None 0 /* There is no constraint to check */
787#define OE_Rollback 1 /* Fail the operation and rollback the transaction */
788#define OE_Abort 2 /* Back out changes but do no rollback transaction */
789#define OE_Fail 3 /* Stop the operation but leave all prior changes */
790#define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */
791#define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */
drhc2eef3b2002-08-31 18:53:06 +0000792
793#define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
794#define OE_SetNull 7 /* Set the foreign key value to NULL */
795#define OE_SetDflt 8 /* Set the foreign key value to its default */
796#define OE_Cascade 9 /* Cascade the changes */
797
798#define OE_Default 99 /* Do whatever the default action is */
drh9cfcf5d2002-01-29 18:41:24 +0000799
drhd3d39e92004-05-20 22:16:29 +0000800
801/*
802** An instance of the following structure is passed as the first
803** argument to sqlite3VdbeKeyCompare and is used to control the
804** comparison of the two index keys.
805**
806** If the KeyInfo.incrKey value is true and the comparison would
drh7e627792005-04-29 02:10:00 +0000807** otherwise be equal, then return a result as if the second key
808** were larger.
drhd3d39e92004-05-20 22:16:29 +0000809*/
810struct KeyInfo {
danielk1977b1bc9532004-05-22 03:05:33 +0000811 u8 enc; /* Text encoding - one of the TEXT_Utf* values */
drhd3d39e92004-05-20 22:16:29 +0000812 u8 incrKey; /* Increase 2nd key by epsilon before comparison */
813 int nField; /* Number of entries in aColl[] */
drhd2d4a6b2006-01-10 15:18:27 +0000814 u8 *aSortOrder; /* If defined an aSortOrder[i] is true, sort DESC */
drhd3d39e92004-05-20 22:16:29 +0000815 CollSeq *aColl[1]; /* Collating sequence for each term of the key */
816};
817
drh9cfcf5d2002-01-29 18:41:24 +0000818/*
drh66b89c82000-11-28 20:47:17 +0000819** Each SQL index is represented in memory by an
drh75897232000-05-29 14:26:00 +0000820** instance of the following structure.
drh967e8b72000-06-21 13:59:10 +0000821**
822** The columns of the table that are to be indexed are described
823** by the aiColumn[] field of this structure. For example, suppose
824** we have the following table and index:
825**
826** CREATE TABLE Ex1(c1 int, c2 int, c3 text);
827** CREATE INDEX Ex2 ON Ex1(c3,c1);
828**
829** In the Table structure describing Ex1, nCol==3 because there are
830** three columns in the table. In the Index structure describing
831** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
832** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the
833** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
834** The second column to be indexed (c1) has an index of 0 in
835** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
drhea1ba172003-04-20 00:00:23 +0000836**
837** The Index.onError field determines whether or not the indexed columns
838** must be unique and what to do if they are not. When Index.onError=OE_None,
839** it means this is not a unique index. Otherwise it is a unique index
840** and the value of Index.onError indicate the which conflict resolution
841** algorithm to employ whenever an attempt is made to insert a non-unique
842** element.
drh75897232000-05-29 14:26:00 +0000843*/
844struct Index {
drh967e8b72000-06-21 13:59:10 +0000845 char *zName; /* Name of this index */
drh967e8b72000-06-21 13:59:10 +0000846 int nColumn; /* Number of columns in the table used by this index */
847 int *aiColumn; /* Which columns are used by this index. 1st is 0 */
drh8b3d9902005-08-19 00:14:42 +0000848 unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
drh967e8b72000-06-21 13:59:10 +0000849 Table *pTable; /* The SQL table being indexed */
drhbe0072d2001-09-13 14:46:09 +0000850 int tnum; /* Page containing root of this index in database file */
drh9cfcf5d2002-01-29 18:41:24 +0000851 u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
drh485b39b2002-07-13 03:11:52 +0000852 u8 autoIndex; /* True if is automatically created (ex: by UNIQUE) */
danielk1977a37cdde2004-05-16 11:15:36 +0000853 char *zColAff; /* String defining the affinity of each column */
drh967e8b72000-06-21 13:59:10 +0000854 Index *pNext; /* The next index associated with the same table */
danielk1977b3bf5562006-01-10 17:58:23 +0000855 Schema *pSchema; /* Schema containing this index */
856 u8 *aSortOrder; /* Array of size Index.nColumn. True==DESC, False==ASC */
857 char **azColl; /* Array of collation sequence names for index */
drh75897232000-05-29 14:26:00 +0000858};
859
860/*
861** Each token coming out of the lexer is an instance of
drh4b59ab52002-08-24 18:24:51 +0000862** this structure. Tokens are also used as part of an expression.
drh4efc4752004-01-16 15:55:37 +0000863**
864** Note if Token.z==0 then Token.dyn and Token.n are undefined and
865** may contain random values. Do not make any assuptions about Token.dyn
866** and Token.n when Token.z==0.
drh75897232000-05-29 14:26:00 +0000867*/
868struct Token {
drh4c755c02004-08-08 20:22:17 +0000869 const unsigned char *z; /* Text of the token. Not NULL-terminated! */
870 unsigned dyn : 1; /* True for malloced memory, false for static */
871 unsigned n : 31; /* Number of characters in this token */
drh75897232000-05-29 14:26:00 +0000872};
873
874/*
drh13449892005-09-07 21:22:45 +0000875** An instance of this structure contains information needed to generate
876** code for a SELECT that contains aggregate functions.
877**
878** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
879** pointer to this structure. The Expr.iColumn field is the index in
880** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
881** code for that node.
882**
883** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
884** original Select structure that describes the SELECT statement. These
885** fields do not need to be freed when deallocating the AggInfo structure.
886*/
887struct AggInfo {
888 u8 directMode; /* Direct rendering mode means take data directly
889 ** from source tables rather than from accumulators */
890 u8 useSortingIdx; /* In direct mode, reference the sorting index rather
891 ** than the source table */
892 int sortingIdx; /* Cursor number of the sorting index */
893 ExprList *pGroupBy; /* The group by clause */
894 int nSortingColumn; /* Number of columns in the sorting index */
895 struct AggInfo_col { /* For each column used in source tables */
896 int iTable; /* Cursor number of the source table */
897 int iColumn; /* Column number within the source table */
898 int iSorterColumn; /* Column number in the sorting index */
899 int iMem; /* Memory location that acts as accumulator */
drh5774b802005-09-07 22:48:16 +0000900 Expr *pExpr; /* The original expression */
drh13449892005-09-07 21:22:45 +0000901 } *aCol;
902 int nColumn; /* Number of used entries in aCol[] */
903 int nColumnAlloc; /* Number of slots allocated for aCol[] */
904 int nAccumulator; /* Number of columns that show through to the output.
905 ** Additional columns are used only as parameters to
906 ** aggregate functions */
907 struct AggInfo_func { /* For each aggregate function */
908 Expr *pExpr; /* Expression encoding the function */
909 FuncDef *pFunc; /* The aggregate function implementation */
910 int iMem; /* Memory location that acts as accumulator */
drhfd357972005-09-09 01:33:19 +0000911 int iDistinct; /* Virtual table used to enforce DISTINCT */
drh13449892005-09-07 21:22:45 +0000912 } *aFunc;
913 int nFunc; /* Number of entries in aFunc[] */
914 int nFuncAlloc; /* Number of slots allocated for aFunc[] */
915};
916
917/*
drh75897232000-05-29 14:26:00 +0000918** Each node of an expression in the parse tree is an instance
drh22f70c32002-02-18 01:17:00 +0000919** of this structure.
920**
921** Expr.op is the opcode. The integer parser token codes are reused
922** as opcodes here. For example, the parser defines TK_GE to be an integer
923** code representing the ">=" operator. This same integer code is reused
924** to represent the greater-than-or-equal-to operator in the expression
925** tree.
926**
927** Expr.pRight and Expr.pLeft are subexpressions. Expr.pList is a list
928** of argument if the expression is a function.
929**
drh4b59ab52002-08-24 18:24:51 +0000930** Expr.token is the operator token for this node. For some expressions
931** that have subexpressions, Expr.token can be the complete text that gave
932** rise to the Expr. In the latter case, the token is marked as being
933** a compound token.
drh22f70c32002-02-18 01:17:00 +0000934**
935** An expression of the form ID or ID.ID refers to a column in a table.
936** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
937** the integer cursor number of a VDBE cursor pointing to that table and
938** Expr.iColumn is the column number for the specific column. If the
939** expression is used as a result in an aggregate SELECT, then the
940** value is also stored in the Expr.iAgg column in the aggregate so that
941** it can be accessed after all aggregates are computed.
942**
943** If the expression is a function, the Expr.iTable is an integer code
drh7c972de2003-09-06 22:18:07 +0000944** representing which function. If the expression is an unbound variable
945** marker (a question mark character '?' in the original SQL) then the
946** Expr.iTable holds the index number for that variable.
drh22f70c32002-02-18 01:17:00 +0000947**
drh1398ad32005-01-19 23:24:50 +0000948** If the expression is a subquery then Expr.iColumn holds an integer
949** register number containing the result of the subquery. If the
950** subquery gives a constant result, then iTable is -1. If the subquery
951** gives a different answer at different times during statement processing
952** then iTable is the address of a subroutine that computes the subquery.
953**
drh22f70c32002-02-18 01:17:00 +0000954** The Expr.pSelect field points to a SELECT statement. The SELECT might
955** be the right operand of an IN operator. Or, if a scalar SELECT appears
956** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
957** operand.
danielk1977aee18ef2005-03-09 12:26:50 +0000958**
959** If the Expr is of type OP_Column, and the table it is selecting from
960** is a disk table or the "old.*" pseudo-table, then pTab points to the
961** corresponding table definition.
drh75897232000-05-29 14:26:00 +0000962*/
963struct Expr {
drh1cc093c2002-06-24 22:01:57 +0000964 u8 op; /* Operation performed by this node */
drha9fd84b2004-05-18 23:21:35 +0000965 char affinity; /* The affinity of the column or 0 if not a column */
drhd2d4a6b2006-01-10 15:18:27 +0000966//u8 iDb; /* Database referenced by this expression */
drhe22a3342003-04-22 20:30:37 +0000967 u8 flags; /* Various flags. See below */
drhf2bc0132004-10-04 13:19:23 +0000968 CollSeq *pColl; /* The collation type of the column or 0 */
drh75897232000-05-29 14:26:00 +0000969 Expr *pLeft, *pRight; /* Left and right subnodes */
drhd99f7062002-06-08 23:25:08 +0000970 ExprList *pList; /* A list of expressions used as function arguments
971 ** or in "<expr> IN (<expr-list)" */
drh75897232000-05-29 14:26:00 +0000972 Token token; /* An operand token */
drh6977fea2002-10-22 23:38:04 +0000973 Token span; /* Complete text of the expression */
drh967e8b72000-06-21 13:59:10 +0000974 int iTable, iColumn; /* When op==TK_COLUMN, then this expr node means the
drh8e2ca022002-06-17 17:07:19 +0000975 ** iColumn-th field of the iTable-th table. */
drh13449892005-09-07 21:22:45 +0000976 AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
977 int iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
drh22d6a532005-09-19 21:05:48 +0000978 int iRightJoinTable; /* If EP_FromJoin, the right table of the join */
drhd99f7062002-06-08 23:25:08 +0000979 Select *pSelect; /* When the expression is a sub-select. Also the
980 ** right side of "<expr> IN (<select>)" */
danielk1977aee18ef2005-03-09 12:26:50 +0000981 Table *pTab; /* Table for OP_Column expressions. */
danielk1977e501b892006-01-09 06:29:47 +0000982 Schema *pSchema;
drh75897232000-05-29 14:26:00 +0000983};
984
985/*
drh1f162302002-10-27 19:35:33 +0000986** The following are the meanings of bits in the Expr.flags field.
987*/
drh392e5972005-07-08 14:14:22 +0000988#define EP_FromJoin 0x01 /* Originated in ON or USING clause of a join */
989#define EP_Agg 0x02 /* Contains one or more aggregate functions */
990#define EP_Resolved 0x04 /* IDs have been resolved to COLUMNs */
991#define EP_Error 0x08 /* Expression contains one or more errors */
drhfd357972005-09-09 01:33:19 +0000992#define EP_Distinct 0x10 /* Aggregate function with DISTINCT keyword */
drh392e5972005-07-08 14:14:22 +0000993#define EP_VarSelect 0x20 /* pSelect is correlated, not constant */
drhd2687b72005-08-12 22:56:09 +0000994#define EP_Dequoted 0x40 /* True if the string has been dequoted */
drh1f162302002-10-27 19:35:33 +0000995
996/*
997** These macros can be used to test, set, or clear bits in the
998** Expr.flags field.
999*/
1000#define ExprHasProperty(E,P) (((E)->flags&(P))==(P))
1001#define ExprHasAnyProperty(E,P) (((E)->flags&(P))!=0)
1002#define ExprSetProperty(E,P) (E)->flags|=(P)
1003#define ExprClearProperty(E,P) (E)->flags&=~(P)
1004
1005/*
drh75897232000-05-29 14:26:00 +00001006** A list of expressions. Each expression may optionally have a
1007** name. An expr/name combination can be used in several ways, such
1008** as the list of "expr AS ID" fields following a "SELECT" or in the
1009** list of "ID = expr" items in an UPDATE. A list of expressions can
drhad3cab52002-05-24 02:04:32 +00001010** also be used as the argument to a function, in which case the a.zName
drh75897232000-05-29 14:26:00 +00001011** field is not used.
1012*/
1013struct ExprList {
1014 int nExpr; /* Number of expressions on the list */
drh4305d102003-07-30 12:34:12 +00001015 int nAlloc; /* Number of entries allocated below */
drh9d2985c2005-09-08 01:58:42 +00001016 int iECursor; /* VDBE Cursor associated with this ExprList */
drh6d4abfb2001-10-22 02:58:08 +00001017 struct ExprList_item {
drh75897232000-05-29 14:26:00 +00001018 Expr *pExpr; /* The list of expressions */
1019 char *zName; /* Token associated with this expression */
drh8e2ca022002-06-17 17:07:19 +00001020 u8 sortOrder; /* 1 for DESC or 0 for ASC */
1021 u8 isAgg; /* True if this is an aggregate like count(*) */
1022 u8 done; /* A flag to indicate when processing is finished */
drh75897232000-05-29 14:26:00 +00001023 } *a; /* One entry for each expression */
1024};
1025
1026/*
drhad3cab52002-05-24 02:04:32 +00001027** An instance of this structure can hold a simple list of identifiers,
1028** such as the list "a,b,c" in the following statements:
1029**
1030** INSERT INTO t(a,b,c) VALUES ...;
1031** CREATE INDEX idx ON t(a,b,c);
1032** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1033**
1034** The IdList.a.idx field is used when the IdList represents the list of
1035** column names after a table name in an INSERT statement. In the statement
1036**
1037** INSERT INTO t(a,b,c) ...
1038**
1039** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
drh75897232000-05-29 14:26:00 +00001040*/
1041struct IdList {
drh6d4abfb2001-10-22 02:58:08 +00001042 struct IdList_item {
drhad3cab52002-05-24 02:04:32 +00001043 char *zName; /* Name of the identifier */
drh967e8b72000-06-21 13:59:10 +00001044 int idx; /* Index in some Table.aCol[] of a column named zName */
drhad3cab52002-05-24 02:04:32 +00001045 } *a;
drh13449892005-09-07 21:22:45 +00001046 int nId; /* Number of identifiers on the list */
1047 int nAlloc; /* Number of entries allocated for a[] below */
drhad3cab52002-05-24 02:04:32 +00001048};
1049
1050/*
drh51669862004-12-18 18:40:26 +00001051** The bitmask datatype defined below is used for various optimizations.
1052*/
1053typedef unsigned int Bitmask;
1054
1055/*
drhad3cab52002-05-24 02:04:32 +00001056** The following structure describes the FROM clause of a SELECT statement.
1057** Each table or subquery in the FROM clause is a separate element of
1058** the SrcList.a[] array.
drhd24cc422003-03-27 12:51:24 +00001059**
1060** With the addition of multiple database support, the following structure
1061** can also be used to describe a particular table such as the table that
1062** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL,
1063** such a table must be a simple name: ID. But in SQLite, the table can
1064** now be identified by a database name, a dot, then the table name: ID.ID.
drhad3cab52002-05-24 02:04:32 +00001065*/
1066struct SrcList {
drh939a16d2004-07-15 13:37:22 +00001067 i16 nSrc; /* Number of tables or subqueries in the FROM clause */
1068 i16 nAlloc; /* Number of entries allocated in a[] below */
drhad3cab52002-05-24 02:04:32 +00001069 struct SrcList_item {
drh113088e2003-03-20 01:16:58 +00001070 char *zDatabase; /* Name of database holding this table */
drhad3cab52002-05-24 02:04:32 +00001071 char *zName; /* Name of the table */
1072 char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */
drhdaffd0e2001-04-11 14:28:42 +00001073 Table *pTab; /* An SQL table corresponding to zName */
1074 Select *pSelect; /* A SELECT statement used in place of a table name */
drhfe05af82005-07-21 03:14:59 +00001075 u8 jointype; /* Type of join between this table and the next */
1076 i16 iCursor; /* The VDBE cursor number used to access this table */
drhad3cab52002-05-24 02:04:32 +00001077 Expr *pOn; /* The ON clause of a join */
1078 IdList *pUsing; /* The USING clause of a join */
drh51669862004-12-18 18:40:26 +00001079 Bitmask colUsed; /* Bit N (1<<N) set if column N or pTab is used */
drh113088e2003-03-20 01:16:58 +00001080 } a[1]; /* One entry for each identifier on the list */
drh75897232000-05-29 14:26:00 +00001081};
1082
1083/*
drh01f3f252002-05-24 16:14:15 +00001084** Permitted values of the SrcList.a.jointype field
1085*/
1086#define JT_INNER 0x0001 /* Any kind of inner or cross join */
drh3dec2232005-09-10 15:28:09 +00001087#define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */
1088#define JT_NATURAL 0x0004 /* True for a "natural" join */
1089#define JT_LEFT 0x0008 /* Left outer join */
1090#define JT_RIGHT 0x0010 /* Right outer join */
1091#define JT_OUTER 0x0020 /* The "OUTER" keyword is present */
1092#define JT_ERROR 0x0040 /* unknown or unsupported join type */
drh01f3f252002-05-24 16:14:15 +00001093
1094/*
drh6b563442001-11-07 16:48:26 +00001095** For each nested loop in a WHERE clause implementation, the WhereInfo
1096** structure contains a single instance of this structure. This structure
1097** is intended to be private the the where.c module and should not be
1098** access or modified by other modules.
1099*/
1100struct WhereLevel {
drh29dda4a2005-07-21 18:23:20 +00001101 int iFrom; /* Which entry in the FROM clause */
1102 int flags; /* Flags associated with this level */
drh51147ba2005-07-23 22:59:55 +00001103 int iMem; /* First memory cell used by this level */
drh29dda4a2005-07-21 18:23:20 +00001104 int iLeftJoin; /* Memory cell used to implement LEFT OUTER JOIN */
1105 Index *pIdx; /* Index used. NULL if no index */
1106 int iTabCur; /* The VDBE cursor used to access the table */
1107 int iIdxCur; /* The VDBE cursor used to acesss pIdx */
1108 int brk; /* Jump here to break out of the loop */
1109 int cont; /* Jump here to continue with the next loop cycle */
1110 int top; /* First instruction of interior of the loop */
1111 int op, p1, p2; /* Opcode used to terminate the loop */
drh51147ba2005-07-23 22:59:55 +00001112 int nEq; /* Number of == or IN constraints on this loop */
drhe23399f2005-07-22 00:31:39 +00001113 int nIn; /* Number of IN operators constraining this loop */
1114 int *aInLoop; /* Loop terminators for IN operators */
drh6b563442001-11-07 16:48:26 +00001115};
1116
1117/*
drh75897232000-05-29 14:26:00 +00001118** The WHERE clause processing routine has two halves. The
1119** first part does the start of the WHERE loop and the second
1120** half does the tail of the WHERE loop. An instance of
1121** this structure is returned by the first half and passed
1122** into the second half to give some continuity.
1123*/
1124struct WhereInfo {
1125 Parse *pParse;
drhad3cab52002-05-24 02:04:32 +00001126 SrcList *pTabList; /* List of tables in the join */
drh9012bcb2004-12-19 00:11:35 +00001127 int iTop; /* The very beginning of the WHERE loop */
drh19a775c2000-06-05 18:54:46 +00001128 int iContinue; /* Jump here to continue with next record */
1129 int iBreak; /* Jump here to break out of the loop */
drh6b563442001-11-07 16:48:26 +00001130 int nLevel; /* Number of nested loop */
1131 WhereLevel a[1]; /* Information about each nest loop in the WHERE */
drh75897232000-05-29 14:26:00 +00001132};
1133
1134/*
danielk1977b3bce662005-01-29 08:32:43 +00001135** A NameContext defines a context in which to resolve table and column
1136** names. The context consists of a list of tables (the pSrcList) field and
1137** a list of named expression (pEList). The named expression list may
1138** be NULL. The pSrc corresponds to the FROM clause of a SELECT or
1139** to the table being operated on by INSERT, UPDATE, or DELETE. The
1140** pEList corresponds to the result set of a SELECT and is NULL for
1141** other statements.
1142**
1143** NameContexts can be nested. When resolving names, the inner-most
1144** context is searched first. If no match is found, the next outer
1145** context is checked. If there is still no match, the next context
1146** is checked. This process continues until either a match is found
1147** or all contexts are check. When a match is found, the nRef member of
1148** the context containing the match is incremented.
1149**
1150** Each subquery gets a new NameContext. The pNext field points to the
1151** NameContext in the parent query. Thus the process of scanning the
1152** NameContext list corresponds to searching through successively outer
1153** subqueries looking for a match.
1154*/
1155struct NameContext {
1156 Parse *pParse; /* The parser */
1157 SrcList *pSrcList; /* One or more tables used to resolve names */
1158 ExprList *pEList; /* Optional list of named expressions */
1159 int nRef; /* Number of names resolved by this context */
1160 int nErr; /* Number of errors encountered while resolving names */
1161 u8 allowAgg; /* Aggregate functions allowed here */
drh13449892005-09-07 21:22:45 +00001162 u8 hasAgg; /* True if aggregates are seen */
drh06f65412005-11-03 02:03:13 +00001163 u8 isCheck; /* True if resolving names in a CHECK constraint */
danielk1977b3bce662005-01-29 08:32:43 +00001164 int nDepth; /* Depth of subquery recursion. 1 for no recursion */
drh13449892005-09-07 21:22:45 +00001165 AggInfo *pAggInfo; /* Information about aggregates at this level */
danielk1977b3bce662005-01-29 08:32:43 +00001166 NameContext *pNext; /* Next outer name context. NULL for outermost */
1167};
1168
1169/*
drh9bb61fe2000-06-05 16:01:39 +00001170** An instance of the following structure contains all information
1171** needed to generate code for a single SELECT statement.
drha76b5df2002-02-23 02:32:10 +00001172**
drhd11d3822002-06-21 23:01:49 +00001173** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0.
1174** If there is a LIMIT clause, the parser sets nLimit to the value of the
1175** limit and nOffset to the value of the offset (or 0 if there is not
1176** offset). But later on, nLimit and nOffset become the memory locations
1177** in the VDBE that record the limit and offset counters.
drh0342b1f2005-09-01 03:07:44 +00001178**
1179** addrOpenVirt[] entries contain the address of OP_OpenVirtual opcodes.
1180** These addresses must be stored so that we can go back and fill in
1181** the P3_KEYINFO and P2 parameters later. Neither the KeyInfo nor
1182** the number of columns in P2 can be computed at the same time
1183** as the OP_OpenVirtual instruction is coded because not
1184** enough information about the compound query is known at that point.
1185** The KeyInfo for addrOpenVirt[0] and [1] contains collating sequences
1186** for the result set. The KeyInfo for addrOpenVirt[2] contains collating
1187** sequences for the ORDER BY clause.
drh9bb61fe2000-06-05 16:01:39 +00001188*/
1189struct Select {
drh9bb61fe2000-06-05 16:01:39 +00001190 ExprList *pEList; /* The fields of the result */
drh7b58dae2003-07-20 01:16:46 +00001191 u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
1192 u8 isDistinct; /* True if the DISTINCT keyword is present */
drh0342b1f2005-09-01 03:07:44 +00001193 u8 isResolved; /* True once sqlite3SelectResolve() has run. */
1194 u8 isAgg; /* True if this is an aggregate query */
1195 u8 usesVirt; /* True if uses an OpenVirtual opcode */
drh4b14b4d2005-09-19 17:35:53 +00001196 u8 disallowOrderBy; /* Do not allow an ORDER BY to be attached if TRUE */
drhad3cab52002-05-24 02:04:32 +00001197 SrcList *pSrc; /* The FROM clause */
drh9bb61fe2000-06-05 16:01:39 +00001198 Expr *pWhere; /* The WHERE clause */
1199 ExprList *pGroupBy; /* The GROUP BY clause */
1200 Expr *pHaving; /* The HAVING clause */
1201 ExprList *pOrderBy; /* The ORDER BY clause */
drh967e8b72000-06-21 13:59:10 +00001202 Select *pPrior; /* Prior select in a compound select statement */
drh0342b1f2005-09-01 03:07:44 +00001203 Select *pRightmost; /* Right-most select in a compound select statement */
danielk1977a2dc3b12005-02-05 12:48:48 +00001204 Expr *pLimit; /* LIMIT expression. NULL means not used. */
1205 Expr *pOffset; /* OFFSET expression. NULL means not used. */
drh7b58dae2003-07-20 01:16:46 +00001206 int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */
drh0342b1f2005-09-01 03:07:44 +00001207 int addrOpenVirt[3]; /* OP_OpenVirtual opcodes related to this select */
drh9bb61fe2000-06-05 16:01:39 +00001208};
1209
1210/*
drhfef52082000-06-06 01:50:43 +00001211** The results of a select can be distributed in several ways.
1212*/
drh13449892005-09-07 21:22:45 +00001213#define SRT_Union 1 /* Store result as keys in an index */
1214#define SRT_Except 2 /* Remove result from a UNION index */
1215#define SRT_Discard 3 /* Do not save the results anywhere */
drhfef52082000-06-06 01:50:43 +00001216
drh13449892005-09-07 21:22:45 +00001217/* The ORDER BY clause is ignored for all of the above */
1218#define IgnorableOrderby(X) (X<=SRT_Discard)
1219
1220#define SRT_Callback 4 /* Invoke a callback with each row of result */
1221#define SRT_Mem 5 /* Store result in a memory cell */
1222#define SRT_Set 6 /* Store non-null results as keys in an index */
drhd49c16e2005-09-08 02:00:25 +00001223#define SRT_Table 7 /* Store result as data with an automatic rowid */
1224#define SRT_VirtualTab 8 /* Create virtual table and store like SRT_Table */
drh9d2985c2005-09-08 01:58:42 +00001225#define SRT_Subroutine 9 /* Call a subroutine to handle results */
drhec7429a2005-10-06 16:53:14 +00001226#define SRT_Exists 10 /* Store 1 if the result is not empty */
drh22827922000-06-06 17:27:05 +00001227
1228/*
drhf57b3392001-10-08 13:22:32 +00001229** An SQL parser context. A copy of this structure is passed through
1230** the parser and down into all the parser action routine in order to
1231** carry around information that is global to the entire parse.
drhf1974842004-11-05 03:56:00 +00001232**
1233** The structure is divided into two parts. When the parser and code
1234** generate call themselves recursively, the first part of the structure
1235** is constant but the second part is reset at the beginning and end of
1236** each recursion.
danielk1977c00da102006-01-07 13:21:04 +00001237**
1238** The nTableLock and aTableLock variables are only used if the shared-cache
1239** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
1240** used to store the set of table-locks required by the statement being
1241** compiled. Function sqlite3TableLock() is used to add entries to the
1242** list.
drh75897232000-05-29 14:26:00 +00001243*/
1244struct Parse {
drh9bb575f2004-09-06 17:24:11 +00001245 sqlite3 *db; /* The main database structure */
drh4c504392000-10-16 22:06:40 +00001246 int rc; /* Return code from execution */
drh75897232000-05-29 14:26:00 +00001247 char *zErrMsg; /* An error message */
drh75897232000-05-29 14:26:00 +00001248 Vdbe *pVdbe; /* An engine for executing database bytecode */
drh836faa42003-01-11 13:30:57 +00001249 u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */
drhe0bc4042002-06-25 01:09:11 +00001250 u8 nameClash; /* A permanent table name clashes with temp table name */
drha6ecd332004-06-10 00:29:09 +00001251 u8 checkSchema; /* Causes schema cookie check after an error */
drh205f48e2004-11-05 00:43:11 +00001252 u8 nested; /* Number of nested calls to the parser/code generator */
drh75897232000-05-29 14:26:00 +00001253 int nErr; /* Number of errors seen */
drh832508b2002-03-02 17:04:07 +00001254 int nTab; /* Number of previously allocated VDBE cursors */
drh19a775c2000-06-05 18:54:46 +00001255 int nMem; /* Number of memory cells used so far */
drhfef52082000-06-06 01:50:43 +00001256 int nSet; /* Number of sets used so far */
drhffe07b22005-11-03 00:41:17 +00001257 int ckOffset; /* Stack offset to data used by CHECK constraints */
drh80242052004-06-09 00:48:12 +00001258 u32 writeMask; /* Start a write transaction on these databases */
drhfcd35c72005-05-21 02:48:08 +00001259 u32 cookieMask; /* Bitmask of schema verified databases */
drh4b494d62006-01-12 12:43:36 +00001260 ThreadData *pTsd; /* Thread specific data for this thread */
drhfcd35c72005-05-21 02:48:08 +00001261 int cookieGoto; /* Address of OP_Goto to cookie verifier subroutine */
1262 int cookieValue[MAX_ATTACHED+2]; /* Values of cookies to verify */
danielk1977c00da102006-01-07 13:21:04 +00001263#ifndef SQLITE_OMIT_SHARED_CACHE
1264 int nTableLock; /* Number of locks in aTableLock */
1265 TableLock *aTableLock; /* Required table locks for shared-cache mode */
1266#endif
drhf1974842004-11-05 03:56:00 +00001267
1268 /* Above is constant between recursions. Below is reset before and after
1269 ** each recursion */
1270
1271 int nVar; /* Number of '?' variables seen in the SQL so far */
1272 int nVarExpr; /* Number of used slots in apVarExpr[] */
1273 int nVarExprAlloc; /* Number of allocated slots in apVarExpr[] */
1274 Expr **apVarExpr; /* Pointers to :aaa and $aaaa wildcard expressions */
1275 u8 explain; /* True if the EXPLAIN flag is found on the query */
drhf1974842004-11-05 03:56:00 +00001276 Token sErrToken; /* The token at which the error occurred */
1277 Token sNameToken; /* Token with unqualified schema object name */
1278 Token sLastToken; /* The last token parsed */
1279 const char *zSql; /* All SQL text */
1280 const char *zTail; /* All SQL text past the last semicolon parsed */
1281 Table *pNewTable; /* A table being constructed by CREATE TABLE */
1282 Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */
1283 TriggerStack *trigStack; /* Trigger actions being coded */
1284 const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
drh75897232000-05-29 14:26:00 +00001285};
1286
danielk1977d99bc932002-05-16 00:13:12 +00001287/*
drh85e20962003-04-25 17:52:11 +00001288** An instance of the following structure can be declared on a stack and used
1289** to save the Parse.zAuthContext value so that it can be restored later.
1290*/
1291struct AuthContext {
1292 const char *zAuthContext; /* Put saved Parse.zAuthContext here */
1293 Parse *pParse; /* The Parse structure */
1294};
1295
1296/*
drhf0863fe2005-06-12 21:35:51 +00001297** Bitfield flags for P2 value in OP_Insert and OP_Delete
rdcb0c374f2004-02-20 22:53:38 +00001298*/
1299#define OPFLAG_NCHANGE 1 /* Set to update db->nChange */
1300#define OPFLAG_LASTROWID 2 /* Set to update db->lastRowid */
danielk197794eb6a12005-12-15 15:22:08 +00001301#define OPFLAG_ISUPDATE 4 /* This OP_Insert is an sql UPDATE */
rdcb0c374f2004-02-20 22:53:38 +00001302
1303/*
danielk1977d99bc932002-05-16 00:13:12 +00001304 * Each trigger present in the database schema is stored as an instance of
1305 * struct Trigger.
1306 *
1307 * Pointers to instances of struct Trigger are stored in two ways.
drh9bb575f2004-09-06 17:24:11 +00001308 * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
danielk1977d99bc932002-05-16 00:13:12 +00001309 * database). This allows Trigger structures to be retrieved by name.
1310 * 2. All triggers associated with a single table form a linked list, using the
drhad3cab52002-05-24 02:04:32 +00001311 * pNext member of struct Trigger. A pointer to the first element of the
1312 * linked list is stored as the "pTrigger" member of the associated
1313 * struct Table.
danielk1977d99bc932002-05-16 00:13:12 +00001314 *
drhad3cab52002-05-24 02:04:32 +00001315 * The "step_list" member points to the first element of a linked list
1316 * containing the SQL statements specified as the trigger program.
danielk1977d99bc932002-05-16 00:13:12 +00001317 */
danielk1977c3f9bad2002-05-15 08:30:12 +00001318struct Trigger {
drhdc379452002-05-15 12:45:43 +00001319 char *name; /* The name of the trigger */
1320 char *table; /* The table or view to which the trigger applies */
drhf0f258b2003-04-21 18:48:45 +00001321 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */
drhdca76842004-12-07 14:06:13 +00001322 u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
drhdc379452002-05-15 12:45:43 +00001323 Expr *pWhen; /* The WHEN clause of the expresion (may be NULL) */
1324 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger,
danielk1977d99bc932002-05-16 00:13:12 +00001325 the <column-list> is stored here */
drhdc379452002-05-15 12:45:43 +00001326 int foreach; /* One of TK_ROW or TK_STATEMENT */
drh4312db52003-06-03 01:47:11 +00001327 Token nameToken; /* Token containing zName. Use during parsing only */
danielk1977e501b892006-01-09 06:29:47 +00001328 Schema *pSchema; /* Schema containing the trigger */
1329 Schema *pTabSchema; /* Schema containing the table */
drhdc379452002-05-15 12:45:43 +00001330 TriggerStep *step_list; /* Link list of trigger program steps */
drhdc379452002-05-15 12:45:43 +00001331 Trigger *pNext; /* Next trigger associated with the table */
danielk1977c3f9bad2002-05-15 08:30:12 +00001332};
1333
danielk1977d99bc932002-05-16 00:13:12 +00001334/*
drhdca76842004-12-07 14:06:13 +00001335** A trigger is either a BEFORE or an AFTER trigger. The following constants
1336** determine which.
1337**
1338** If there are multiple triggers, you might of some BEFORE and some AFTER.
1339** In that cases, the constants below can be ORed together.
1340*/
1341#define TRIGGER_BEFORE 1
1342#define TRIGGER_AFTER 2
1343
1344/*
danielk1977d99bc932002-05-16 00:13:12 +00001345 * An instance of struct TriggerStep is used to store a single SQL statement
1346 * that is a part of a trigger-program.
1347 *
1348 * Instances of struct TriggerStep are stored in a singly linked list (linked
1349 * using the "pNext" member) referenced by the "step_list" member of the
1350 * associated struct Trigger instance. The first element of the linked list is
1351 * the first step of the trigger-program.
1352 *
1353 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
1354 * "SELECT" statement. The meanings of the other members is determined by the
1355 * value of "op" as follows:
1356 *
1357 * (op == TK_INSERT)
1358 * orconf -> stores the ON CONFLICT algorithm
1359 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then
1360 * this stores a pointer to the SELECT statement. Otherwise NULL.
1361 * target -> A token holding the name of the table to insert into.
1362 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
1363 * this stores values to be inserted. Otherwise NULL.
1364 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ...
drhad3cab52002-05-24 02:04:32 +00001365 * statement, then this stores the column-names to be
1366 * inserted into.
danielk1977d99bc932002-05-16 00:13:12 +00001367 *
1368 * (op == TK_DELETE)
1369 * target -> A token holding the name of the table to delete from.
1370 * pWhere -> The WHERE clause of the DELETE statement if one is specified.
1371 * Otherwise NULL.
1372 *
1373 * (op == TK_UPDATE)
1374 * target -> A token holding the name of the table to update rows of.
1375 * pWhere -> The WHERE clause of the UPDATE statement if one is specified.
1376 * Otherwise NULL.
1377 * pExprList -> A list of the columns to update and the expressions to update
danielk19774adee202004-05-08 08:23:19 +00001378 * them to. See sqlite3Update() documentation of "pChanges"
drhad3cab52002-05-24 02:04:32 +00001379 * argument.
danielk1977d99bc932002-05-16 00:13:12 +00001380 *
1381 */
1382struct TriggerStep {
1383 int op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1384 int orconf; /* OE_Rollback etc. */
drha69d9162003-04-17 22:57:53 +00001385 Trigger *pTrig; /* The trigger that this step is a part of */
danielk1977c3f9bad2002-05-15 08:30:12 +00001386
danielk1977d99bc932002-05-16 00:13:12 +00001387 Select *pSelect; /* Valid for SELECT and sometimes
1388 INSERT steps (when pExprList == 0) */
1389 Token target; /* Valid for DELETE, UPDATE, INSERT steps */
1390 Expr *pWhere; /* Valid for DELETE, UPDATE steps */
1391 ExprList *pExprList; /* Valid for UPDATE statements and sometimes
1392 INSERT steps (when pSelect == 0) */
1393 IdList *pIdList; /* Valid for INSERT statements only */
1394
1395 TriggerStep * pNext; /* Next in the link-list */
1396};
1397
1398/*
1399 * An instance of struct TriggerStack stores information required during code
1400 * generation of a single trigger program. While the trigger program is being
1401 * coded, its associated TriggerStack instance is pointed to by the
1402 * "pTriggerStack" member of the Parse structure.
1403 *
1404 * The pTab member points to the table that triggers are being coded on. The
1405 * newIdx member contains the index of the vdbe cursor that points at the temp
1406 * table that stores the new.* references. If new.* references are not valid
1407 * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1408 * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1409 *
1410 * The ON CONFLICT policy to be used for the trigger program steps is stored
1411 * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1412 * specified for individual triggers steps is used.
1413 *
1414 * struct TriggerStack has a "pNext" member, to allow linked lists to be
1415 * constructed. When coding nested triggers (triggers fired by other triggers)
1416 * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1417 * pointer. Once the nested trigger has been coded, the pNext value is restored
1418 * to the pTriggerStack member of the Parse stucture and coding of the parent
1419 * trigger continues.
1420 *
1421 * Before a nested trigger is coded, the linked list pointed to by the
1422 * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1423 * recursively. If this condition is detected, the nested trigger is not coded.
1424 */
1425struct TriggerStack {
1426 Table *pTab; /* Table that triggers are currently being coded on */
1427 int newIdx; /* Index of vdbe cursor to "new" temp table */
1428 int oldIdx; /* Index of vdbe cursor to "old" temp table */
1429 int orconf; /* Current orconf policy */
danielk19776f349032002-06-11 02:25:40 +00001430 int ignoreJump; /* where to jump to for a RAISE(IGNORE) */
drhe22a3342003-04-22 20:30:37 +00001431 Trigger *pTrigger; /* The trigger currently being coded */
1432 TriggerStack *pNext; /* Next trigger down on the trigger stack */
danielk1977d99bc932002-05-16 00:13:12 +00001433};
1434
1435/*
drhf26e09c2003-05-31 16:21:12 +00001436** The following structure contains information used by the sqliteFix...
1437** routines as they walk the parse tree to make database references
1438** explicit.
1439*/
1440typedef struct DbFixer DbFixer;
1441struct DbFixer {
1442 Parse *pParse; /* The parsing context. Error messages written here */
1443 const char *zDb; /* Make sure all objects are contained in this database */
1444 const char *zType; /* Type of the container - used for error messages */
1445 const Token *pName; /* Name of the container - used for error messages */
1446};
1447
1448/*
drh234c39d2004-07-24 03:30:47 +00001449** A pointer to this structure is used to communicate information
1450** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
1451*/
1452typedef struct {
drh9bb575f2004-09-06 17:24:11 +00001453 sqlite3 *db; /* The database being initialized */
drh234c39d2004-07-24 03:30:47 +00001454 char **pzErrMsg; /* Error message stored here */
1455} InitData;
1456
drhb6c29892004-11-22 19:12:19 +00001457/*
danielk1977d99bc932002-05-16 00:13:12 +00001458 * This global flag is set for performance testing of triggers. When it is set
1459 * SQLite will perform the overhead of building new and old trigger references
1460 * even when no triggers exist
1461 */
drh38f82712004-06-18 17:10:16 +00001462extern int sqlite3_always_code_trigger_setup;
danielk1977c3f9bad2002-05-15 08:30:12 +00001463
drh75897232000-05-29 14:26:00 +00001464/*
drh49285702005-09-17 15:20:26 +00001465** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production
1466** builds) or a function call (for debugging). If it is a function call,
1467** it allows the operator to set a breakpoint at the spot where database
1468** corruption is first detected.
1469*/
1470#ifdef SQLITE_DEBUG
1471 extern int sqlite3Corrupt(void);
1472# define SQLITE_CORRUPT_BKPT sqlite3Corrupt()
1473#else
1474# define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT
1475#endif
1476
1477/*
drh75897232000-05-29 14:26:00 +00001478** Internal function prototypes
1479*/
danielk19774adee202004-05-08 08:23:19 +00001480int sqlite3StrICmp(const char *, const char *);
1481int sqlite3StrNICmp(const char *, const char *, int);
1482int sqlite3HashNoCase(const char *, int);
danielk19778a6b5412004-05-24 07:04:25 +00001483int sqlite3IsNumber(const char*, int*, u8);
danielk19774adee202004-05-08 08:23:19 +00001484int sqlite3Compare(const char *, const char *);
1485int sqlite3SortCompare(const char *, const char *);
1486void sqlite3RealToSortable(double r, char *);
danielk19772e588c72005-12-09 14:25:08 +00001487
1488void *sqlite3Malloc(int);
1489void *sqlite3MallocRaw(int);
1490void sqlite3Free(void*);
1491void *sqlite3Realloc(void*,int);
1492char *sqlite3StrDup(const char*);
1493char *sqlite3StrNDup(const char*, int);
danielk19774adee202004-05-08 08:23:19 +00001494# define sqlite3CheckMemory(a,b)
drh53f733c2005-09-16 02:38:09 +00001495void sqlite3ReallocOrFree(void**,int);
drh998da3a2004-06-19 15:22:56 +00001496void sqlite3FreeX(void*);
drh132d8d62005-05-22 20:12:37 +00001497void *sqlite3MallocX(int);
danielk197713f72992005-12-18 08:51:22 +00001498int sqlite3AllocSize(void *);
danielk19772e588c72005-12-09 14:25:08 +00001499
danielk19774adee202004-05-08 08:23:19 +00001500char *sqlite3MPrintf(const char*, ...);
1501char *sqlite3VMPrintf(const char*, va_list);
drhe54ca3f2004-06-07 01:52:14 +00001502void sqlite3DebugPrintf(const char*, ...);
drhfe63d1c2004-09-08 20:13:04 +00001503void *sqlite3TextToPtr(const char*);
drh41f58522005-06-06 15:06:39 +00001504void sqlite3SetString(char **, ...);
danielk19774adee202004-05-08 08:23:19 +00001505void sqlite3ErrorMsg(Parse*, const char*, ...);
drha0733842005-12-29 01:11:36 +00001506void sqlite3ErrorClear(Parse*);
danielk19774adee202004-05-08 08:23:19 +00001507void sqlite3Dequote(char*);
drhd2687b72005-08-12 22:56:09 +00001508void sqlite3DequoteExpr(Expr*);
drh2646da72005-12-09 20:02:05 +00001509int sqlite3KeywordCode(const unsigned char*, int);
danielk19774adee202004-05-08 08:23:19 +00001510int sqlite3RunParser(Parse*, const char*, char **);
drh80242052004-06-09 00:48:12 +00001511void sqlite3FinishCoding(Parse*);
drhe4e72072004-11-23 01:47:30 +00001512Expr *sqlite3Expr(int, Expr*, Expr*, const Token*);
drh4e0cff62004-11-05 05:10:28 +00001513Expr *sqlite3RegisterExpr(Parse*,Token*);
drh91bb0ee2004-09-01 03:06:34 +00001514Expr *sqlite3ExprAnd(Expr*, Expr*);
danielk19774adee202004-05-08 08:23:19 +00001515void sqlite3ExprSpan(Expr*,Token*,Token*);
1516Expr *sqlite3ExprFunction(ExprList*, Token*);
drhfa6bc002004-09-07 16:19:52 +00001517void sqlite3ExprAssignVarNumber(Parse*, Expr*);
danielk19774adee202004-05-08 08:23:19 +00001518void sqlite3ExprDelete(Expr*);
1519ExprList *sqlite3ExprListAppend(ExprList*,Expr*,Token*);
1520void sqlite3ExprListDelete(ExprList*);
drh9bb575f2004-09-06 17:24:11 +00001521int sqlite3Init(sqlite3*, char**);
drh234c39d2004-07-24 03:30:47 +00001522int sqlite3InitCallback(void*, int, char**, char**);
danielk197791cf71b2004-06-26 06:37:06 +00001523void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
drh9bb575f2004-09-06 17:24:11 +00001524void sqlite3ResetInternalSchema(sqlite3*, int);
danielk19774adee202004-05-08 08:23:19 +00001525void sqlite3BeginParse(Parse*,int);
drh9bb575f2004-09-06 17:24:11 +00001526void sqlite3RollbackInternalChanges(sqlite3*);
1527void sqlite3CommitInternalChanges(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00001528Table *sqlite3ResultSetOfSelect(Parse*,char*,Select*);
danielk1977c00da102006-01-07 13:21:04 +00001529void sqlite3OpenMasterTable(Parse *, int);
drhfaa59552005-12-29 23:33:54 +00001530void sqlite3StartTable(Parse*,Token*,Token*,Token*,int,int,int);
danielk19774adee202004-05-08 08:23:19 +00001531void sqlite3AddColumn(Parse*,Token*);
1532void sqlite3AddNotNull(Parse*, int);
drhfdd6e852005-12-16 01:06:16 +00001533void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
drhffe07b22005-11-03 00:41:17 +00001534void sqlite3AddCheckConstraint(Parse*, Expr*);
drh487e2622005-06-25 18:42:14 +00001535void sqlite3AddColumnType(Parse*,Token*);
danielk19777977a172004-11-09 12:44:37 +00001536void sqlite3AddDefaultValue(Parse*,Expr*);
drhd3d39e92004-05-20 22:16:29 +00001537void sqlite3AddCollateType(Parse*, const char*, int);
danielk197719a8e7e2005-03-17 05:03:38 +00001538void sqlite3EndTable(Parse*,Token*,Token*,Select*);
drhb7f91642004-10-31 02:22:47 +00001539
1540#ifndef SQLITE_OMIT_VIEW
1541 void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int);
1542 int sqlite3ViewGetColumnNames(Parse*,Table*);
1543#else
1544# define sqlite3ViewGetColumnNames(A,B) 0
1545#endif
1546
drha0733842005-12-29 01:11:36 +00001547void sqlite3DropTable(Parse*, SrcList*, int, int);
drh9bb575f2004-09-06 17:24:11 +00001548void sqlite3DeleteTable(sqlite3*, Table*);
danielk19774adee202004-05-08 08:23:19 +00001549void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
drh13449892005-09-07 21:22:45 +00001550int sqlite3ArrayAllocate(void**,int,int);
danielk19774adee202004-05-08 08:23:19 +00001551IdList *sqlite3IdListAppend(IdList*, Token*);
1552int sqlite3IdListIndex(IdList*,const char*);
1553SrcList *sqlite3SrcListAppend(SrcList*, Token*, Token*);
1554void sqlite3SrcListAddAlias(SrcList*, Token*);
1555void sqlite3SrcListAssignCursors(Parse*, SrcList*);
1556void sqlite3IdListDelete(IdList*);
1557void sqlite3SrcListDelete(SrcList*);
danielk19770202b292004-06-09 09:55:16 +00001558void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
drh4d91a702006-01-04 15:54:36 +00001559 Token*, int, int);
1560void sqlite3DropIndex(Parse*, SrcList*, int);
danielk19774adee202004-05-08 08:23:19 +00001561void sqlite3AddKeyType(Vdbe*, ExprList*);
1562void sqlite3AddIdxKeyType(Vdbe*, Index*);
danielk1977b3bce662005-01-29 08:32:43 +00001563int sqlite3Select(Parse*, Select*, int, int, Select*, int, int*, char *aff);
danielk19774adee202004-05-08 08:23:19 +00001564Select *sqlite3SelectNew(ExprList*,SrcList*,Expr*,ExprList*,Expr*,ExprList*,
danielk1977a2dc3b12005-02-05 12:48:48 +00001565 int,Expr*,Expr*);
danielk19774adee202004-05-08 08:23:19 +00001566void sqlite3SelectDelete(Select*);
1567void sqlite3SelectUnbind(Select*);
1568Table *sqlite3SrcListLookup(Parse*, SrcList*);
1569int sqlite3IsReadOnly(Parse*, Table*, int);
danielk1977c00da102006-01-07 13:21:04 +00001570void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
danielk19774adee202004-05-08 08:23:19 +00001571void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
1572void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
drhf8db1bc2005-04-22 02:38:37 +00001573WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**);
danielk19774adee202004-05-08 08:23:19 +00001574void sqlite3WhereEnd(WhereInfo*);
1575void sqlite3ExprCode(Parse*, Expr*);
drh25303782004-12-07 15:41:48 +00001576void sqlite3ExprCodeAndCache(Parse*, Expr*);
drhf9b596e2004-05-26 16:54:42 +00001577int sqlite3ExprCodeExprList(Parse*, ExprList*);
danielk19774adee202004-05-08 08:23:19 +00001578void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
1579void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
drh205f48e2004-11-05 00:43:11 +00001580void sqlite3NextedParse(Parse*, const char*, ...);
drh9bb575f2004-09-06 17:24:11 +00001581Table *sqlite3FindTable(sqlite3*,const char*, const char*);
danielk19774adee202004-05-08 08:23:19 +00001582Table *sqlite3LocateTable(Parse*,const char*, const char*);
drh9bb575f2004-09-06 17:24:11 +00001583Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
1584void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
1585void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
danielk19774adee202004-05-08 08:23:19 +00001586void sqlite3Vacuum(Parse*, Token*);
drh9bb575f2004-09-06 17:24:11 +00001587int sqlite3RunVacuum(char**, sqlite3*);
drha99db3b2004-06-19 14:49:12 +00001588char *sqlite3NameFromToken(Token*);
danielk19774adee202004-05-08 08:23:19 +00001589int sqlite3ExprCheck(Parse*, Expr*, int, int*);
danielk19774adee202004-05-08 08:23:19 +00001590int sqlite3ExprCompare(Expr*, Expr*);
drhcce7d172000-05-31 15:34:51 +00001591int sqliteFuncId(Token*);
danielk1977b3bce662005-01-29 08:32:43 +00001592int sqlite3ExprResolveNames(NameContext *, Expr *);
danielk1977a58fdfb2005-02-08 07:50:40 +00001593int sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
drh5d9a4af2005-08-30 00:54:01 +00001594int sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
danielk19774adee202004-05-08 08:23:19 +00001595Vdbe *sqlite3GetVdbe(Parse*);
1596void sqlite3Randomness(int, void*);
drh9bb575f2004-09-06 17:24:11 +00001597void sqlite3RollbackAll(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00001598void sqlite3CodeVerifySchema(Parse*, int);
drh684917c2004-10-05 02:41:42 +00001599void sqlite3BeginTransaction(Parse*, int);
danielk19774adee202004-05-08 08:23:19 +00001600void sqlite3CommitTransaction(Parse*);
1601void sqlite3RollbackTransaction(Parse*);
1602int sqlite3ExprIsConstant(Expr*);
drheb55bd22005-06-30 17:04:21 +00001603int sqlite3ExprIsConstantOrFunction(Expr*);
danielk19774adee202004-05-08 08:23:19 +00001604int sqlite3ExprIsInteger(Expr*, int*);
1605int sqlite3IsRowid(const char*);
drh9bb575f2004-09-06 17:24:11 +00001606void sqlite3GenerateRowDelete(sqlite3*, Vdbe*, Table*, int, int);
1607void sqlite3GenerateRowIndexDelete(sqlite3*, Vdbe*, Table*, int, char*);
drh51846b52004-05-28 16:00:21 +00001608void sqlite3GenerateIndexKey(Vdbe*, Index*, int);
danielk19774adee202004-05-08 08:23:19 +00001609void sqlite3GenerateConstraintChecks(Parse*,Table*,int,char*,int,int,int,int);
1610void sqlite3CompleteInsertion(Parse*, Table*, int, char*, int, int, int);
drh290c1942004-08-21 17:54:45 +00001611void sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
danielk19774adee202004-05-08 08:23:19 +00001612void sqlite3BeginWriteOperation(Parse*, int, int);
danielk19774adee202004-05-08 08:23:19 +00001613Expr *sqlite3ExprDup(Expr*);
1614void sqlite3TokenCopy(Token*, Token*);
1615ExprList *sqlite3ExprListDup(ExprList*);
1616SrcList *sqlite3SrcListDup(SrcList*);
1617IdList *sqlite3IdListDup(IdList*);
1618Select *sqlite3SelectDup(Select*);
drh9bb575f2004-09-06 17:24:11 +00001619FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
1620void sqlite3RegisterBuiltinFunctions(sqlite3*);
1621void sqlite3RegisterDateTimeFunctions(sqlite3*);
1622int sqlite3SafetyOn(sqlite3*);
1623int sqlite3SafetyOff(sqlite3*);
1624int sqlite3SafetyCheck(sqlite3*);
1625void sqlite3ChangeCookie(sqlite3*, Vdbe*, int);
drhb7f91642004-10-31 02:22:47 +00001626
1627#ifndef SQLITE_OMIT_TRIGGER
1628 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
1629 int,Expr*,int);
1630 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
1631 void sqlite3DropTrigger(Parse*, SrcList*);
1632 void sqlite3DropTriggerPtr(Parse*, Trigger*, int);
drhdca76842004-12-07 14:06:13 +00001633 int sqlite3TriggersExist(Parse*, Table*, int, ExprList*);
drhb7f91642004-10-31 02:22:47 +00001634 int sqlite3CodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
1635 int, int);
1636 void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
1637 void sqlite3DeleteTriggerStep(TriggerStep*);
1638 TriggerStep *sqlite3TriggerSelectStep(Select*);
1639 TriggerStep *sqlite3TriggerInsertStep(Token*, IdList*, ExprList*,Select*,int);
1640 TriggerStep *sqlite3TriggerUpdateStep(Token*, ExprList*, Expr*, int);
1641 TriggerStep *sqlite3TriggerDeleteStep(Token*, Expr*);
1642 void sqlite3DeleteTrigger(Trigger*);
1643 void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
1644#else
1645# define sqlite3TriggersExist(A,B,C,D,E,F) 0
1646# define sqlite3DeleteTrigger(A)
1647# define sqlite3DropTriggerPtr(A,B,C)
1648# define sqlite3UnlinkAndDeleteTrigger(A,B,C)
1649# define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I) 0
1650#endif
1651
danielk19774adee202004-05-08 08:23:19 +00001652int sqlite3JoinType(Parse*, Token*, Token*, Token*);
danielk19770202b292004-06-09 09:55:16 +00001653void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
danielk19774adee202004-05-08 08:23:19 +00001654void sqlite3DeferForeignKey(Parse*, int);
drhed6c8672003-01-12 18:02:16 +00001655#ifndef SQLITE_OMIT_AUTHORIZATION
danielk19774adee202004-05-08 08:23:19 +00001656 void sqlite3AuthRead(Parse*,Expr*,SrcList*);
1657 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
1658 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
1659 void sqlite3AuthContextPop(AuthContext*);
drhed6c8672003-01-12 18:02:16 +00001660#else
danielk19774adee202004-05-08 08:23:19 +00001661# define sqlite3AuthRead(a,b,c)
1662# define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK
1663# define sqlite3AuthContextPush(a,b,c)
1664# define sqlite3AuthContextPop(a) ((void)(a))
drhed6c8672003-01-12 18:02:16 +00001665#endif
danielk1977f744bb52005-12-06 17:19:11 +00001666void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
1667void sqlite3Detach(Parse*, Expr*);
drh9bb575f2004-09-06 17:24:11 +00001668int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
drh90f5ecb2004-07-22 01:19:35 +00001669 int omitJournal, int nCache, Btree **ppBtree);
danielk19774adee202004-05-08 08:23:19 +00001670int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
1671int sqlite3FixSrcList(DbFixer*, SrcList*);
1672int sqlite3FixSelect(DbFixer*, Select*);
1673int sqlite3FixExpr(DbFixer*, Expr*);
1674int sqlite3FixExprList(DbFixer*, ExprList*);
1675int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
drh487e2622005-06-25 18:42:14 +00001676int sqlite3AtoF(const char *z, double*);
danielk19776f8a5032004-05-10 10:34:51 +00001677char *sqlite3_snprintf(int,char*,const char*,...);
drhfec19aa2004-05-19 20:41:03 +00001678int sqlite3GetInt32(const char *, int*);
drhfec19aa2004-05-19 20:41:03 +00001679int sqlite3FitsIn64Bits(const char *);
danielk19776622cce2004-05-20 11:00:52 +00001680int sqlite3utf16ByteLen(const void *pData, int nChar);
1681int sqlite3utf8CharLen(const char *pData, int nByte);
drh4e5ffc52004-08-31 00:52:37 +00001682int sqlite3ReadUtf8(const unsigned char *);
danielk1977192ac1d2004-05-10 07:17:30 +00001683int sqlite3PutVarint(unsigned char *, u64);
danielk197790e4d952004-05-10 10:05:53 +00001684int sqlite3GetVarint(const unsigned char *, u64 *);
drh6d2fb152004-05-14 16:50:06 +00001685int sqlite3GetVarint32(const unsigned char *, u32 *);
danielk1977192ac1d2004-05-10 07:17:30 +00001686int sqlite3VarintLen(u64 v);
danielk1977a37cdde2004-05-16 11:15:36 +00001687void sqlite3IndexAffinityStr(Vdbe *, Index *);
1688void sqlite3TableAffinityStr(Vdbe *, Table *);
danielk1977e014a832004-05-17 10:48:57 +00001689char sqlite3CompareAffinity(Expr *pExpr, char aff2);
danielk1977e014a832004-05-17 10:48:57 +00001690int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
danielk1977bf3b7212004-05-18 10:06:24 +00001691char sqlite3ExprAffinity(Expr *pExpr);
drheb2e1762004-05-27 01:53:56 +00001692int sqlite3atoi64(const char*, i64*);
drh9bb575f2004-09-06 17:24:11 +00001693void sqlite3Error(sqlite3*, int, const char*,...);
danielk1977cbb18d22004-05-28 11:37:27 +00001694void *sqlite3HexToBlob(const char *z);
danielk1977ef2cb632004-05-29 02:37:19 +00001695int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
danielk1977f20b21c2004-05-31 23:56:42 +00001696const char *sqlite3ErrStr(int);
danielk1977d02eb1f2004-06-06 09:44:03 +00001697int sqlite3ReadUniChar(const char *zStr, int *pOffset, u8 *pEnc, int fold);
danielk19778a414492004-06-29 08:59:35 +00001698int sqlite3ReadSchema(Parse *pParse);
drh9bb575f2004-09-06 17:24:11 +00001699CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
danielk19770202b292004-06-09 09:55:16 +00001700CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
danielk19777cedc8d2004-06-10 10:50:08 +00001701CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
1702int sqlite3CheckCollSeq(Parse *, CollSeq *);
1703int sqlite3CheckIndexCollSeq(Parse *, Index *);
danielk1977d8123362004-06-12 09:25:12 +00001704int sqlite3CheckObjectName(Parse *, const char *);
danielk1977b28af712004-06-21 06:50:26 +00001705void sqlite3VdbeSetChanges(sqlite3 *, int);
danielk1977f4618892004-06-28 13:09:11 +00001706void sqlite3utf16Substr(sqlite3_context *,int,sqlite3_value **);
danielk19774e6af132004-06-10 14:01:08 +00001707
1708const void *sqlite3ValueText(sqlite3_value*, u8);
1709int sqlite3ValueBytes(sqlite3_value*, u8);
danielk1977bfd6cce2004-06-18 04:24:54 +00001710void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8, void(*)(void*));
danielk19774e6af132004-06-10 14:01:08 +00001711void sqlite3ValueFree(sqlite3_value*);
drh4f26bb62005-09-08 14:17:20 +00001712sqlite3_value *sqlite3ValueNew(void);
drhaf9a7c22005-12-15 03:04:10 +00001713char *sqlite3utf16to8(const void*, int);
danielk1977aee18ef2005-03-09 12:26:50 +00001714int sqlite3ValueFromExpr(Expr *, u8, u8, sqlite3_value **);
1715void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
drh4e5ffc52004-08-31 00:52:37 +00001716extern const unsigned char sqlite3UpperToLower[];
danielk1977a0bf2652004-11-04 14:30:04 +00001717void sqlite3RootPageMoved(Db*, int, int);
drh4343fea2004-11-05 23:46:15 +00001718void sqlite3Reindex(Parse*, Token*, Token*);
drh1f01ec12005-02-15 21:36:18 +00001719void sqlite3AlterFunctions(sqlite3*);
danielk19779fd2a9a2004-11-12 13:42:30 +00001720void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
1721int sqlite3GetToken(const unsigned char *, int *);
drh2958a4e2004-11-12 03:56:15 +00001722void sqlite3NestedParse(Parse*, const char*, ...);
drhd89bd002005-01-22 03:03:54 +00001723void sqlite3ExpirePreparedStatements(sqlite3*);
danielk1977b3bce662005-01-29 08:32:43 +00001724void sqlite3CodeSubselect(Parse *, Expr *);
1725int sqlite3SelectResolve(Parse *, Select *, NameContext *);
danielk1977aee18ef2005-03-09 12:26:50 +00001726void sqlite3ColumnDefault(Vdbe *, Table *, int);
danielk197719a8e7e2005-03-17 05:03:38 +00001727void sqlite3AlterFinishAddColumn(Parse *, Token *);
1728void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
drh2e66f0b2005-04-28 17:18:48 +00001729const char *sqlite3TestErrorName(int);
danielk19774dade032005-05-25 10:45:10 +00001730CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int);
drh8a512562005-11-14 22:29:05 +00001731char sqlite3AffinityType(const Token*);
drh9f18e8a2005-07-08 12:13:04 +00001732void sqlite3Analyze(Parse*, Token*, Token*);
drha4afb652005-07-09 02:16:02 +00001733int sqlite3InvokeBusyHandler(BusyHandler*);
drhff2d5ea2005-07-23 00:41:48 +00001734int sqlite3FindDb(sqlite3*, Token*);
drh497e4462005-07-23 03:18:40 +00001735void sqlite3AnalysisLoad(sqlite3*,int iDB);
drh51147ba2005-07-23 22:59:55 +00001736void sqlite3DefaultRowEst(Index*);
drh55ef4d92005-08-14 01:20:37 +00001737void sqlite3RegisterLikeFunctions(sqlite3*, int);
drhd64fe2f2005-08-28 17:00:23 +00001738int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
drh6f7adc82006-01-11 21:41:20 +00001739ThreadData *sqlite3ThreadData(void);
1740const ThreadData *sqlite3ThreadDataReadOnly(void);
1741void sqlite3ReleaseThreadData(void);
danielk1977f744bb52005-12-06 17:19:11 +00001742void sqlite3AttachFunctions(sqlite3 *);
drhfdd6e852005-12-16 01:06:16 +00001743void sqlite3MinimumFileFormat(Parse*, int, int);
danielk1977da184232006-01-05 11:34:32 +00001744void sqlite3SchemaFree(void *);
danielk1977e501b892006-01-09 06:29:47 +00001745Schema *sqlite3SchemaGet(Btree *);
1746int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
danielk1977b3bf5562006-01-10 17:58:23 +00001747KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *);
danielk1977e3026632004-06-22 11:29:02 +00001748
danielk1977c00da102006-01-07 13:21:04 +00001749#ifndef SQLITE_OMIT_SHARED_CACHE
1750 void sqlite3TableLock(Parse *, int, int, u8, const char *);
1751#else
1752 #define sqlite3TableLock(v,w,x,y,z)
1753#endif
1754
danielk19772e588c72005-12-09 14:25:08 +00001755void sqlite3MallocClearFailed();
1756#ifdef NDEBUG
1757 #define sqlite3MallocDisallow()
1758 #define sqlite3MallocAllow()
1759#else
1760 void sqlite3MallocDisallow();
1761 void sqlite3MallocAllow();
1762#endif
1763
danielk1977fd9a0a42005-05-24 12:01:00 +00001764#ifdef SQLITE_SSE
1765#include "sseInt.h"
1766#endif
1767
danielk1977e3026632004-06-22 11:29:02 +00001768#endif