blob: 5a4c7dc41ee2816f40095bd6a2f9e87c049d75f2 [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**
drh836faa42003-01-11 13:30:57 +000014** @(#) $Id: sqliteInt.h,v 1.152 2003/01/11 13:30:58 drh Exp $
drh75897232000-05-29 14:26:00 +000015*/
drh58f391b2002-11-20 11:55:18 +000016#include "config.h"
drh75897232000-05-29 14:26:00 +000017#include "sqlite.h"
drhbeae3192001-09-22 18:12:08 +000018#include "hash.h"
drh75897232000-05-29 14:26:00 +000019#include "vdbe.h"
20#include "parse.h"
drhbe0072d2001-09-13 14:46:09 +000021#include "btree.h"
drh75897232000-05-29 14:26:00 +000022#include <stdio.h>
23#include <stdlib.h>
24#include <string.h>
25#include <assert.h>
26
drh967e8b72000-06-21 13:59:10 +000027/*
drha1b351a2001-09-14 16:42:12 +000028** The maximum number of in-memory pages to use for the main database
29** table and for temporary tables.
30*/
drh603240c2002-03-05 01:11:12 +000031#define MAX_PAGES 2000
32#define TEMP_PAGES 500
drha1b351a2001-09-14 16:42:12 +000033
34/*
drh0bd1f4e2002-06-06 18:54:39 +000035** If the following macro is set to 1, then NULL values are considered
36** distinct for the SELECT DISTINCT statement and for UNION or EXCEPT
37** compound queries. No other SQL database engine (among those tested)
38** works this way except for OCELOT. But the SQL92 spec implies that
39** this is how things should work.
40**
41** If the following macro is set to 0, then NULLs are indistinct for
42** SELECT DISTINCT and for UNION.
43*/
44#define NULL_ALWAYS_DISTINCT 0
45
46/*
47** If the following macro is set to 1, then NULL values are considered
48** distinct when determining whether or not two entries are the same
49** in a UNIQUE index. This is the way PostgreSQL, Oracle, DB2, MySQL,
50** OCELOT, and Firebird all work. The SQL92 spec explicitly says this
51** is the way things are suppose to work.
52**
53** If the following macro is set to 0, the NULLs are indistinct for
54** a UNIQUE index. In this mode, you can only have a single NULL entry
55** for a column declared UNIQUE. This is the way Informix and SQL Server
56** work.
57*/
58#define NULL_DISTINCT_FOR_UNIQUE 1
59
60/*
drh5a2c2c22001-11-21 02:21:11 +000061** Integers of known sizes. These typedefs might change for architectures
62** where the sizes very. Preprocessor macros are available so that the
63** types can be conveniently redefined at compile-type. Like this:
64**
65** cc '-DUINTPTR_TYPE=long long int' ...
drh41a2b482001-01-20 19:52:49 +000066*/
drh5a2c2c22001-11-21 02:21:11 +000067#ifndef UINT32_TYPE
68# define UINT32_TYPE unsigned int
69#endif
70#ifndef UINT16_TYPE
71# define UINT16_TYPE unsigned short int
72#endif
73#ifndef UINT8_TYPE
74# define UINT8_TYPE unsigned char
75#endif
76#ifndef INTPTR_TYPE
drh58f391b2002-11-20 11:55:18 +000077# if SQLITE_PTR_SZ==4
78# define INTPTR_TYPE int
79# else
80# define INTPTR_TYPE long long
81# endif
drh5a2c2c22001-11-21 02:21:11 +000082#endif
83typedef UINT32_TYPE u32; /* 4-byte unsigned integer */
84typedef UINT16_TYPE u16; /* 2-byte unsigned integer */
85typedef UINT8_TYPE u8; /* 1-byte unsigned integer */
86typedef INTPTR_TYPE ptr; /* Big enough to hold a pointer */
87typedef unsigned INTPTR_TYPE uptr; /* Big enough to hold a pointer */
88
89/*
90** This macro casts a pointer to an integer. Useful for doing
91** pointer arithmetic.
92*/
93#define Addr(X) ((uptr)X)
drh41a2b482001-01-20 19:52:49 +000094
95/*
drh872ff862001-09-15 14:43:39 +000096** The maximum number of bytes of data that can be put into a single
drh80ff32f2001-11-04 18:32:46 +000097** row of a single table. The upper bound on this limit is 16777215
98** bytes (or 16MB-1). We have arbitrarily set the limit to just 1MB
99** here because the overflow page chain is inefficient for really big
100** records and we want to discourage people from thinking that
101** multi-megabyte records are OK. If your needs are different, you can
102** change this define and recompile to increase or decrease the record
103** size.
drh872ff862001-09-15 14:43:39 +0000104*/
drh80ff32f2001-11-04 18:32:46 +0000105#define MAX_BYTES_PER_ROW 1048576
drh872ff862001-09-15 14:43:39 +0000106
107/*
drh967e8b72000-06-21 13:59:10 +0000108** If memory allocation problems are found, recompile with
109**
110** -DMEMORY_DEBUG=1
111**
112** to enable some sanity checking on malloc() and free(). To
113** check for memory leaks, recompile with
114**
115** -DMEMORY_DEBUG=2
116**
117** and a line of text will be written to standard error for
118** each malloc() and free(). This output can be analyzed
119** by an AWK script to determine if there are any leaks.
120*/
drhdcc581c2000-05-30 13:44:19 +0000121#ifdef MEMORY_DEBUG
drh8c1238a2003-01-02 14:43:55 +0000122# define sqliteMalloc(X) sqliteMalloc_(X,1,__FILE__,__LINE__)
123# define sqliteMallocRaw(X) sqliteMalloc_(X,0,__FILE__,__LINE__)
drhdcc581c2000-05-30 13:44:19 +0000124# define sqliteFree(X) sqliteFree_(X,__FILE__,__LINE__)
125# define sqliteRealloc(X,Y) sqliteRealloc_(X,Y,__FILE__,__LINE__)
drh6e142f52000-06-08 13:36:40 +0000126# define sqliteStrDup(X) sqliteStrDup_(X,__FILE__,__LINE__)
127# define sqliteStrNDup(X,Y) sqliteStrNDup_(X,Y,__FILE__,__LINE__)
drhc3c2fc92000-05-31 22:58:39 +0000128 void sqliteStrRealloc(char**);
129#else
130# define sqliteStrRealloc(X)
drhdcc581c2000-05-30 13:44:19 +0000131#endif
132
drh75897232000-05-29 14:26:00 +0000133/*
drhdaffd0e2001-04-11 14:28:42 +0000134** This variable gets set if malloc() ever fails. After it gets set,
135** the SQLite library shuts down permanently.
136*/
137extern int sqlite_malloc_failed;
138
139/*
drh6e142f52000-06-08 13:36:40 +0000140** The following global variables are used for testing and debugging
drh8c82b352000-12-10 18:23:50 +0000141** only. They only work if MEMORY_DEBUG is defined.
drh6e142f52000-06-08 13:36:40 +0000142*/
143#ifdef MEMORY_DEBUG
drh8c82b352000-12-10 18:23:50 +0000144extern int sqlite_nMalloc; /* Number of sqliteMalloc() calls */
145extern int sqlite_nFree; /* Number of sqliteFree() calls */
146extern int sqlite_iMallocFail; /* Fail sqliteMalloc() after this many calls */
drh6e142f52000-06-08 13:36:40 +0000147#endif
148
149/*
drh75897232000-05-29 14:26:00 +0000150** Name of the master database table. The master database table
151** is a special table that holds the names and attributes of all
152** user tables and indices.
153*/
drhe0bc4042002-06-25 01:09:11 +0000154#define MASTER_NAME "sqlite_master"
155#define TEMP_MASTER_NAME "sqlite_temp_master"
drh75897232000-05-29 14:26:00 +0000156
157/*
158** A convenience macro that returns the number of elements in
159** an array.
160*/
161#define ArraySize(X) (sizeof(X)/sizeof(X[0]))
162
163/*
164** Forward references to structures
165*/
drh7020f652000-06-03 18:06:52 +0000166typedef struct Column Column;
drh75897232000-05-29 14:26:00 +0000167typedef struct Table Table;
168typedef struct Index Index;
169typedef struct Instruction Instruction;
170typedef struct Expr Expr;
171typedef struct ExprList ExprList;
172typedef struct Parse Parse;
173typedef struct Token Token;
174typedef struct IdList IdList;
drhad3cab52002-05-24 02:04:32 +0000175typedef struct SrcList SrcList;
drh75897232000-05-29 14:26:00 +0000176typedef struct WhereInfo WhereInfo;
drh6b563442001-11-07 16:48:26 +0000177typedef struct WhereLevel WhereLevel;
drh9bb61fe2000-06-05 16:01:39 +0000178typedef struct Select Select;
drh22827922000-06-06 17:27:05 +0000179typedef struct AggExpr AggExpr;
drh0bce8352002-02-28 00:41:10 +0000180typedef struct FuncDef FuncDef;
danielk1977c3f9bad2002-05-15 08:30:12 +0000181typedef struct Trigger Trigger;
182typedef struct TriggerStep TriggerStep;
183typedef struct TriggerStack TriggerStack;
drhc2eef3b2002-08-31 18:53:06 +0000184typedef struct FKey FKey;
drh75897232000-05-29 14:26:00 +0000185
186/*
drhc9b84a12002-06-20 11:36:48 +0000187** Each database is an instance of the following structure.
188**
189** The sqlite.file_format is initialized by the database file
190** and helps determines how the data in the database file is
191** represented. This field allows newer versions of the library
192** to read and write older databases. The various file formats
193** are as follows:
194**
195** file_format==1 Version 2.1.0.
196** file_format==2 Version 2.2.0. Add support for INTEGER PRIMARY KEY.
drh491791a2002-07-18 00:34:09 +0000197** file_format==3 Version 2.6.0. Fix empty-string index bug.
198** file_format==4 Version 2.7.0. Add support for separate numeric and
drhc9b84a12002-06-20 11:36:48 +0000199** text datatypes.
drh75897232000-05-29 14:26:00 +0000200*/
201struct sqlite {
drh5e00f6c2001-09-13 13:46:56 +0000202 Btree *pBe; /* The B*Tree backend */
drhf57b3392001-10-08 13:22:32 +0000203 Btree *pBeTemp; /* Backend for session temporary tables */
drh5e00f6c2001-09-13 13:46:56 +0000204 int flags; /* Miscellanous flags. See below */
205 int file_format; /* What file format version is this database? */
drh50e5dad2001-09-15 00:57:28 +0000206 int schema_cookie; /* Magic number that changes with the schema */
207 int next_cookie; /* Value of schema_cookie after commit */
drhcd61c282002-03-06 22:01:34 +0000208 int cache_size; /* Number of pages to use in the cache */
drh5e00f6c2001-09-13 13:46:56 +0000209 int nTable; /* Number of tables in the database */
210 void *pBusyArg; /* 1st Argument to the busy callback */
drh353f57e2000-08-02 12:26:28 +0000211 int (*xBusyCallback)(void *,const char*,int); /* The busy callback */
drhbeae3192001-09-22 18:12:08 +0000212 Hash tblHash; /* All tables indexed by name */
213 Hash idxHash; /* All (named) indices indexed by name */
drhe0bc4042002-06-25 01:09:11 +0000214 Hash trigHash; /* All triggers indexed by name */
drh0bce8352002-02-28 00:41:10 +0000215 Hash aFunc; /* All functions that can be in SQL exprs */
drhc2eef3b2002-08-31 18:53:06 +0000216 Hash aFKey; /* Foreign keys indexed by to-table */
drhaf9ff332002-01-16 21:00:27 +0000217 int lastRowid; /* ROWID of most recent insert */
drh5cf8e8c2002-02-19 22:42:05 +0000218 int priorNewRowid; /* Last randomly generated ROWID */
drh1c928532002-01-31 15:54:21 +0000219 int onError; /* Default conflict algorithm */
drh247be432002-05-10 05:44:55 +0000220 int magic; /* Magic number for detect library misuse */
drhc8d30ac2002-04-12 10:08:59 +0000221 int nChange; /* Number of rows changed */
222 int recursionDepth; /* Number of nested calls to sqlite_exec() */
drh75897232000-05-29 14:26:00 +0000223};
224
225/*
drh967e8b72000-06-21 13:59:10 +0000226** Possible values for the sqlite.flags.
drh75897232000-05-29 14:26:00 +0000227*/
drh5e00f6c2001-09-13 13:46:56 +0000228#define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */
229#define SQLITE_Initialized 0x00000002 /* True after initialization */
230#define SQLITE_Interrupt 0x00000004 /* Cancel current operation */
231#define SQLITE_InTrans 0x00000008 /* True if in a transaction */
232#define SQLITE_InternChanges 0x00000010 /* Uncommitted Hash table changes */
drh382c0242001-10-06 16:33:02 +0000233#define SQLITE_FullColNames 0x00000020 /* Show full column names on SELECT */
drh1bee3d72001-10-15 00:44:35 +0000234#define SQLITE_CountRows 0x00000040 /* Count rows changed by INSERT, */
235 /* DELETE, or UPDATE and return */
236 /* the count using a callback. */
drh6a535342001-10-19 16:44:56 +0000237#define SQLITE_NullCallback 0x00000080 /* Invoke the callback once if the */
238 /* result set is empty */
drhc3a64ba2001-11-22 00:01:27 +0000239#define SQLITE_ResultDetails 0x00000100 /* Details added to result set */
drh417be792002-03-03 18:59:40 +0000240#define SQLITE_UnresetViews 0x00000200 /* True if one or more views have */
241 /* defined column names */
drh5080aaa2002-07-11 12:18:16 +0000242#define SQLITE_ReportTypes 0x00000400 /* Include information on datatypes */
243 /* in 4th argument of callback */
drh58b95762000-06-02 01:17:37 +0000244
245/*
drh247be432002-05-10 05:44:55 +0000246** Possible values for the sqlite.magic field.
247** The numbers are obtained at random and have no special meaning, other
248** than being distinct from one another.
249*/
250#define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */
251#define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */
252#define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */
253#define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */
254
255/*
drh0bce8352002-02-28 00:41:10 +0000256** Each SQL function is defined by an instance of the following
257** structure. A pointer to this structure is stored in the sqlite.aFunc
drh8e0a2f92002-02-23 23:45:45 +0000258** hash table. When multiple functions have the same name, the hash table
259** points to a linked list of these structures.
drh28037572000-08-02 13:47:41 +0000260*/
drh0bce8352002-02-28 00:41:10 +0000261struct FuncDef {
drh0bd1f4e2002-06-06 18:54:39 +0000262 void (*xFunc)(sqlite_func*,int,const char**); /* Regular function */
drh56c0e922002-03-12 23:10:04 +0000263 void (*xStep)(sqlite_func*,int,const char**); /* Aggregate function step */
drh1350b032002-02-27 19:00:20 +0000264 void (*xFinalize)(sqlite_func*); /* Aggregate function finializer */
265 int nArg; /* Number of arguments */
drhc9b84a12002-06-20 11:36:48 +0000266 int dataType; /* Datatype of the result */
drh1350b032002-02-27 19:00:20 +0000267 void *pUserData; /* User data parameter */
drh0bce8352002-02-28 00:41:10 +0000268 FuncDef *pNext; /* Next function with same name */
drh8e0a2f92002-02-23 23:45:45 +0000269};
drh28037572000-08-02 13:47:41 +0000270
271/*
drh967e8b72000-06-21 13:59:10 +0000272** information about each column of an SQL table is held in an instance
drh7020f652000-06-03 18:06:52 +0000273** of this structure.
274*/
275struct Column {
drh967e8b72000-06-21 13:59:10 +0000276 char *zName; /* Name of this column */
277 char *zDflt; /* Default value of this column */
drh382c0242001-10-06 16:33:02 +0000278 char *zType; /* Data type for this column */
drh4a324312001-12-21 14:30:42 +0000279 u8 notNull; /* True if there is a NOT NULL constraint */
280 u8 isPrimKey; /* True if this column is an INTEGER PRIMARY KEY */
drh8e2ca022002-06-17 17:07:19 +0000281 u8 sortOrder; /* Some combination of SQLITE_SO_... values */
drh7020f652000-06-03 18:06:52 +0000282};
283
284/*
drh8e2ca022002-06-17 17:07:19 +0000285** The allowed sort orders.
286**
287** The TEXT and NUM values use bits that do not overlap with DESC and ASC.
288** That way the two can be combined into a single number.
289*/
290#define SQLITE_SO_UNK 0 /* Use the default collating type. (SCT_NUM) */
291#define SQLITE_SO_TEXT 2 /* Sort using memcmp() */
292#define SQLITE_SO_NUM 4 /* Sort using sqliteCompare() */
293#define SQLITE_SO_TYPEMASK 6 /* Mask to extract the collating sequence */
294#define SQLITE_SO_ASC 0 /* Sort in ascending order */
295#define SQLITE_SO_DESC 1 /* Sort in descending order */
296#define SQLITE_SO_DIRMASK 1 /* Mask to extract the sort direction */
297
298/*
drh22f70c32002-02-18 01:17:00 +0000299** Each SQL table is represented in memory by an instance of the
300** following structure.
301**
302** Expr.zName is the name of the table. The case of the original
303** CREATE TABLE statement is stored, but case is not significant for
304** comparisons.
305**
306** Expr.nCol is the number of columns in this table. Expr.aCol is a
307** pointer to an array of Column structures, one for each column.
308**
309** If the table has an INTEGER PRIMARY KEY, then Expr.iPKey is the index of
310** the column that is that key. Otherwise Expr.iPKey is negative. Note
311** that the datatype of the PRIMARY KEY must be INTEGER for this field to
312** be set. An INTEGER PRIMARY KEY is used as the rowid for each row of
313** the table. If a table has no INTEGER PRIMARY KEY, then a random rowid
314** is generated for each row of the table. Expr.hasPrimKey is true if
315** the table has any PRIMARY KEY, INTEGER or otherwise.
316**
317** Expr.tnum is the page number for the root BTree page of the table in the
318** database file. If Expr.isTemp is true, then this page occurs in the
319** auxiliary database file, not the main database file. If Expr.isTransient
320** is true, then the table is stored in a file that is automatically deleted
321** when the VDBE cursor to the table is closed. In this case Expr.tnum
322** refers VDBE cursor number that holds the table open, not to the root
323** page number. Transient tables are used to hold the results of a
324** sub-query that appears instead of a real table name in the FROM clause
325** of a SELECT statement.
drh75897232000-05-29 14:26:00 +0000326*/
327struct Table {
drh967e8b72000-06-21 13:59:10 +0000328 char *zName; /* Name of the table */
drh967e8b72000-06-21 13:59:10 +0000329 int nCol; /* Number of columns in this table */
330 Column *aCol; /* Information about each column */
drhc8392582001-12-31 02:48:51 +0000331 int iPKey; /* If not less then 0, use aCol[iPKey] as the primary key */
drh967e8b72000-06-21 13:59:10 +0000332 Index *pIndex; /* List of SQL indexes on this table. */
drh22f70c32002-02-18 01:17:00 +0000333 int tnum; /* Root BTree node for this table (see note above) */
drha76b5df2002-02-23 02:32:10 +0000334 Select *pSelect; /* NULL for tables. Points to definition if a view. */
drh717e6402001-09-27 03:22:32 +0000335 u8 readOnly; /* True if this table should not be written by the user */
drhf57b3392001-10-08 13:22:32 +0000336 u8 isTemp; /* True if stored in db->pBeTemp instead of db->pBe */
drh22f70c32002-02-18 01:17:00 +0000337 u8 isTransient; /* True if automatically deleted when VDBE finishes */
drh4a324312001-12-21 14:30:42 +0000338 u8 hasPrimKey; /* True if there exists a primary key */
drh9cfcf5d2002-01-29 18:41:24 +0000339 u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */
danielk1977c3f9bad2002-05-15 08:30:12 +0000340 Trigger *pTrigger; /* List of SQL triggers on this table */
drhc2eef3b2002-08-31 18:53:06 +0000341 FKey *pFKey; /* Linked list of all foreign keys in this table */
drh75897232000-05-29 14:26:00 +0000342};
343
344/*
drhc2eef3b2002-08-31 18:53:06 +0000345** Each foreign key constraint is an instance of the following structure.
346**
347** A foreign key is associated with two tables. The "from" table is
348** the table that contains the REFERENCES clause that creates the foreign
349** key. The "to" table is the table that is named in the REFERENCES clause.
350** Consider this example:
351**
352** CREATE TABLE ex1(
353** a INTEGER PRIMARY KEY,
354** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
355** );
356**
357** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
358**
359** Each REFERENCES clause generates an instance of the following structure
360** which is attached to the from-table. The to-table need not exist when
361** the from-table is created. The existance of the to-table is not checked
362** until an attempt is made to insert data into the from-table.
363**
364** The sqlite.aFKey hash table stores pointers to to this structure
365** given the name of a to-table. For each to-table, all foreign keys
366** associated with that table are on a linked list using the FKey.pNextTo
367** field.
368*/
369struct FKey {
370 Table *pFrom; /* The table that constains the REFERENCES clause */
371 FKey *pNextFrom; /* Next foreign key in pFrom */
372 char *zTo; /* Name of table that the key points to */
373 FKey *pNextTo; /* Next foreign key that points to zTo */
374 int nCol; /* Number of columns in this key */
375 struct sColMap { /* Mapping of columns in pFrom to columns in zTo */
376 int iFrom; /* Index of column in pFrom */
377 char *zCol; /* Name of column in zTo. If 0 use PRIMARY KEY */
378 } *aCol; /* One entry for each of nCol column s */
379 u8 isDeferred; /* True if constraint checking is deferred till COMMIT */
380 u8 updateConf; /* How to resolve conflicts that occur on UPDATE */
381 u8 deleteConf; /* How to resolve conflicts that occur on DELETE */
382 u8 insertConf; /* How to resolve conflicts that occur on INSERT */
383};
384
385/*
386** SQLite supports many different ways to resolve a contraint
drh22f70c32002-02-18 01:17:00 +0000387** error. ROLLBACK processing means that a constraint violation
drh0bd1f4e2002-06-06 18:54:39 +0000388** causes the operation in process to fail and for the current transaction
drh1c928532002-01-31 15:54:21 +0000389** to be rolled back. ABORT processing means the operation in process
390** fails and any prior changes from that one operation are backed out,
391** but the transaction is not rolled back. FAIL processing means that
392** the operation in progress stops and returns an error code. But prior
393** changes due to the same operation are not backed out and no rollback
394** occurs. IGNORE means that the particular row that caused the constraint
395** error is not inserted or updated. Processing continues and no error
396** is returned. REPLACE means that preexisting database rows that caused
397** a UNIQUE constraint violation are removed so that the new insert or
398** update can proceed. Processing continues and no error is reported.
drhc2eef3b2002-08-31 18:53:06 +0000399**
400** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
401** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
402** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign
403** key is set to NULL. CASCADE means that a DELETE or UPDATE of the
404** referenced table row is propagated into the row that holds the
405** foreign key.
drh1c928532002-01-31 15:54:21 +0000406**
407** The following there symbolic values are used to record which type
408** of action to take.
drh9cfcf5d2002-01-29 18:41:24 +0000409*/
drh1c928532002-01-31 15:54:21 +0000410#define OE_None 0 /* There is no constraint to check */
411#define OE_Rollback 1 /* Fail the operation and rollback the transaction */
412#define OE_Abort 2 /* Back out changes but do no rollback transaction */
413#define OE_Fail 3 /* Stop the operation but leave all prior changes */
414#define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */
415#define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */
drhc2eef3b2002-08-31 18:53:06 +0000416
417#define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
418#define OE_SetNull 7 /* Set the foreign key value to NULL */
419#define OE_SetDflt 8 /* Set the foreign key value to its default */
420#define OE_Cascade 9 /* Cascade the changes */
421
422#define OE_Default 99 /* Do whatever the default action is */
drh9cfcf5d2002-01-29 18:41:24 +0000423
424/*
drh66b89c82000-11-28 20:47:17 +0000425** Each SQL index is represented in memory by an
drh75897232000-05-29 14:26:00 +0000426** instance of the following structure.
drh967e8b72000-06-21 13:59:10 +0000427**
428** The columns of the table that are to be indexed are described
429** by the aiColumn[] field of this structure. For example, suppose
430** we have the following table and index:
431**
432** CREATE TABLE Ex1(c1 int, c2 int, c3 text);
433** CREATE INDEX Ex2 ON Ex1(c3,c1);
434**
435** In the Table structure describing Ex1, nCol==3 because there are
436** three columns in the table. In the Index structure describing
437** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
438** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the
439** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
440** The second column to be indexed (c1) has an index of 0 in
441** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
drh75897232000-05-29 14:26:00 +0000442*/
443struct Index {
drh967e8b72000-06-21 13:59:10 +0000444 char *zName; /* Name of this index */
drh967e8b72000-06-21 13:59:10 +0000445 int nColumn; /* Number of columns in the table used by this index */
446 int *aiColumn; /* Which columns are used by this index. 1st is 0 */
447 Table *pTable; /* The SQL table being indexed */
drhbe0072d2001-09-13 14:46:09 +0000448 int tnum; /* Page containing root of this index in database file */
drh9cfcf5d2002-01-29 18:41:24 +0000449 u8 isUnique; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
drh9cfcf5d2002-01-29 18:41:24 +0000450 u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
drh485b39b2002-07-13 03:11:52 +0000451 u8 autoIndex; /* True if is automatically created (ex: by UNIQUE) */
drh967e8b72000-06-21 13:59:10 +0000452 Index *pNext; /* The next index associated with the same table */
drh75897232000-05-29 14:26:00 +0000453};
454
455/*
456** Each token coming out of the lexer is an instance of
drh4b59ab52002-08-24 18:24:51 +0000457** this structure. Tokens are also used as part of an expression.
drh75897232000-05-29 14:26:00 +0000458*/
459struct Token {
drh80ff32f2001-11-04 18:32:46 +0000460 const char *z; /* Text of the token. Not NULL-terminated! */
drh4b59ab52002-08-24 18:24:51 +0000461 unsigned dyn : 1; /* True for malloced memory, false for static */
drh6977fea2002-10-22 23:38:04 +0000462 unsigned n : 31; /* Number of characters in this token */
drh75897232000-05-29 14:26:00 +0000463};
464
465/*
466** Each node of an expression in the parse tree is an instance
drh22f70c32002-02-18 01:17:00 +0000467** of this structure.
468**
469** Expr.op is the opcode. The integer parser token codes are reused
470** as opcodes here. For example, the parser defines TK_GE to be an integer
471** code representing the ">=" operator. This same integer code is reused
472** to represent the greater-than-or-equal-to operator in the expression
473** tree.
474**
475** Expr.pRight and Expr.pLeft are subexpressions. Expr.pList is a list
476** of argument if the expression is a function.
477**
drh4b59ab52002-08-24 18:24:51 +0000478** Expr.token is the operator token for this node. For some expressions
479** that have subexpressions, Expr.token can be the complete text that gave
480** rise to the Expr. In the latter case, the token is marked as being
481** a compound token.
drh22f70c32002-02-18 01:17:00 +0000482**
483** An expression of the form ID or ID.ID refers to a column in a table.
484** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
485** the integer cursor number of a VDBE cursor pointing to that table and
486** Expr.iColumn is the column number for the specific column. If the
487** expression is used as a result in an aggregate SELECT, then the
488** value is also stored in the Expr.iAgg column in the aggregate so that
489** it can be accessed after all aggregates are computed.
490**
491** If the expression is a function, the Expr.iTable is an integer code
492** representing which function.
493**
494** The Expr.pSelect field points to a SELECT statement. The SELECT might
495** be the right operand of an IN operator. Or, if a scalar SELECT appears
496** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
497** operand.
drh75897232000-05-29 14:26:00 +0000498*/
499struct Expr {
drh1cc093c2002-06-24 22:01:57 +0000500 u8 op; /* Operation performed by this node */
drh8e2ca022002-06-17 17:07:19 +0000501 u8 dataType; /* Either SQLITE_SO_TEXT or SQLITE_SO_NUM */
drh1f162302002-10-27 19:35:33 +0000502 u16 flags; /* Various flags. See below */
drh75897232000-05-29 14:26:00 +0000503 Expr *pLeft, *pRight; /* Left and right subnodes */
drhd99f7062002-06-08 23:25:08 +0000504 ExprList *pList; /* A list of expressions used as function arguments
505 ** or in "<expr> IN (<expr-list)" */
drh75897232000-05-29 14:26:00 +0000506 Token token; /* An operand token */
drh6977fea2002-10-22 23:38:04 +0000507 Token span; /* Complete text of the expression */
drh967e8b72000-06-21 13:59:10 +0000508 int iTable, iColumn; /* When op==TK_COLUMN, then this expr node means the
drh8e2ca022002-06-17 17:07:19 +0000509 ** iColumn-th field of the iTable-th table. */
drh967e8b72000-06-21 13:59:10 +0000510 int iAgg; /* When op==TK_COLUMN and pParse->useAgg==TRUE, pull
511 ** result from the iAgg-th element of the aggregator */
drhd99f7062002-06-08 23:25:08 +0000512 Select *pSelect; /* When the expression is a sub-select. Also the
513 ** right side of "<expr> IN (<select>)" */
drh75897232000-05-29 14:26:00 +0000514};
515
516/*
drh1f162302002-10-27 19:35:33 +0000517** The following are the meanings of bits in the Expr.flags field.
518*/
519#define EP_FromJoin 0x0001 /* Originated in ON or USING clause of a join */
520#define EP_Oracle8Join 0x0002 /* Carries the Oracle8 "(+)" join operator */
521
522/*
523** These macros can be used to test, set, or clear bits in the
524** Expr.flags field.
525*/
526#define ExprHasProperty(E,P) (((E)->flags&(P))==(P))
527#define ExprHasAnyProperty(E,P) (((E)->flags&(P))!=0)
528#define ExprSetProperty(E,P) (E)->flags|=(P)
529#define ExprClearProperty(E,P) (E)->flags&=~(P)
530
531/*
drh75897232000-05-29 14:26:00 +0000532** A list of expressions. Each expression may optionally have a
533** name. An expr/name combination can be used in several ways, such
534** as the list of "expr AS ID" fields following a "SELECT" or in the
535** list of "ID = expr" items in an UPDATE. A list of expressions can
drhad3cab52002-05-24 02:04:32 +0000536** also be used as the argument to a function, in which case the a.zName
drh75897232000-05-29 14:26:00 +0000537** field is not used.
538*/
539struct ExprList {
540 int nExpr; /* Number of expressions on the list */
drh6d4abfb2001-10-22 02:58:08 +0000541 struct ExprList_item {
drh75897232000-05-29 14:26:00 +0000542 Expr *pExpr; /* The list of expressions */
543 char *zName; /* Token associated with this expression */
drh8e2ca022002-06-17 17:07:19 +0000544 u8 sortOrder; /* 1 for DESC or 0 for ASC */
545 u8 isAgg; /* True if this is an aggregate like count(*) */
546 u8 done; /* A flag to indicate when processing is finished */
drh75897232000-05-29 14:26:00 +0000547 } *a; /* One entry for each expression */
548};
549
550/*
drhad3cab52002-05-24 02:04:32 +0000551** An instance of this structure can hold a simple list of identifiers,
552** such as the list "a,b,c" in the following statements:
553**
554** INSERT INTO t(a,b,c) VALUES ...;
555** CREATE INDEX idx ON t(a,b,c);
556** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
557**
558** The IdList.a.idx field is used when the IdList represents the list of
559** column names after a table name in an INSERT statement. In the statement
560**
561** INSERT INTO t(a,b,c) ...
562**
563** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
drh75897232000-05-29 14:26:00 +0000564*/
565struct IdList {
566 int nId; /* Number of identifiers on the list */
drh6d4abfb2001-10-22 02:58:08 +0000567 struct IdList_item {
drhad3cab52002-05-24 02:04:32 +0000568 char *zName; /* Name of the identifier */
drh967e8b72000-06-21 13:59:10 +0000569 int idx; /* Index in some Table.aCol[] of a column named zName */
drhad3cab52002-05-24 02:04:32 +0000570 } *a;
571};
572
573/*
574** The following structure describes the FROM clause of a SELECT statement.
575** Each table or subquery in the FROM clause is a separate element of
576** the SrcList.a[] array.
577*/
578struct SrcList {
579 int nSrc; /* Number of tables or subqueries in the FROM clause */
580 struct SrcList_item {
581 char *zName; /* Name of the table */
582 char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */
drhdaffd0e2001-04-11 14:28:42 +0000583 Table *pTab; /* An SQL table corresponding to zName */
584 Select *pSelect; /* A SELECT statement used in place of a table name */
drhad3cab52002-05-24 02:04:32 +0000585 int jointype; /* Type of join between this table and the next */
586 Expr *pOn; /* The ON clause of a join */
587 IdList *pUsing; /* The USING clause of a join */
drh75897232000-05-29 14:26:00 +0000588 } *a; /* One entry for each identifier on the list */
589};
590
591/*
drh01f3f252002-05-24 16:14:15 +0000592** Permitted values of the SrcList.a.jointype field
593*/
594#define JT_INNER 0x0001 /* Any kind of inner or cross join */
595#define JT_NATURAL 0x0002 /* True for a "natural" join */
drh195e6962002-05-25 00:18:20 +0000596#define JT_LEFT 0x0004 /* Left outer join */
597#define JT_RIGHT 0x0008 /* Right outer join */
drh01f3f252002-05-24 16:14:15 +0000598#define JT_OUTER 0x0010 /* The "OUTER" keyword is present */
599#define JT_ERROR 0x0020 /* unknown or unsupported join type */
600
601/*
drh6b563442001-11-07 16:48:26 +0000602** For each nested loop in a WHERE clause implementation, the WhereInfo
603** structure contains a single instance of this structure. This structure
604** is intended to be private the the where.c module and should not be
605** access or modified by other modules.
606*/
607struct WhereLevel {
608 int iMem; /* Memory cell used by this level */
609 Index *pIdx; /* Index used */
610 int iCur; /* Cursor number used for this index */
drh487ab3c2001-11-08 00:45:21 +0000611 int score; /* How well this indexed scored */
drh6b563442001-11-07 16:48:26 +0000612 int brk; /* Jump here to break out of the loop */
613 int cont; /* Jump here to continue with the next loop cycle */
614 int op, p1, p2; /* Opcode used to terminate the loop */
drhad2d8302002-05-24 20:31:36 +0000615 int iLeftJoin; /* Memory cell used to implement LEFT OUTER JOIN */
616 int top; /* First instruction of interior of the loop */
drhd99f7062002-06-08 23:25:08 +0000617 int inOp, inP1, inP2;/* Opcode used to implement an IN operator */
drhc045ec52002-12-04 20:01:06 +0000618 int bRev; /* Do the scan in the reverse direction */
drh6b563442001-11-07 16:48:26 +0000619};
620
621/*
drh75897232000-05-29 14:26:00 +0000622** The WHERE clause processing routine has two halves. The
623** first part does the start of the WHERE loop and the second
624** half does the tail of the WHERE loop. An instance of
625** this structure is returned by the first half and passed
626** into the second half to give some continuity.
627*/
628struct WhereInfo {
629 Parse *pParse;
drhad3cab52002-05-24 02:04:32 +0000630 SrcList *pTabList; /* List of tables in the join */
drh19a775c2000-06-05 18:54:46 +0000631 int iContinue; /* Jump here to continue with next record */
632 int iBreak; /* Jump here to break out of the loop */
633 int base; /* Index of first Open opcode */
drh6b563442001-11-07 16:48:26 +0000634 int nLevel; /* Number of nested loop */
drh832508b2002-03-02 17:04:07 +0000635 int savedNTab; /* Value of pParse->nTab before WhereBegin() */
636 int peakNTab; /* Value of pParse->nTab after WhereBegin() */
drh6b563442001-11-07 16:48:26 +0000637 WhereLevel a[1]; /* Information about each nest loop in the WHERE */
drh75897232000-05-29 14:26:00 +0000638};
639
640/*
drh9bb61fe2000-06-05 16:01:39 +0000641** An instance of the following structure contains all information
642** needed to generate code for a single SELECT statement.
drha76b5df2002-02-23 02:32:10 +0000643**
644** The zSelect field is used when the Select structure must be persistent.
645** Normally, the expression tree points to tokens in the original input
646** string that encodes the select. But if the Select structure must live
647** longer than its input string (for example when it is used to describe
648** a VIEW) we have to make a copy of the input string so that the nodes
649** of the expression tree will have something to point to. zSelect is used
650** to hold that copy.
drhd11d3822002-06-21 23:01:49 +0000651**
652** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0.
653** If there is a LIMIT clause, the parser sets nLimit to the value of the
654** limit and nOffset to the value of the offset (or 0 if there is not
655** offset). But later on, nLimit and nOffset become the memory locations
656** in the VDBE that record the limit and offset counters.
drh9bb61fe2000-06-05 16:01:39 +0000657*/
658struct Select {
659 int isDistinct; /* True if the DISTINCT keyword is present */
660 ExprList *pEList; /* The fields of the result */
drhad3cab52002-05-24 02:04:32 +0000661 SrcList *pSrc; /* The FROM clause */
drh9bb61fe2000-06-05 16:01:39 +0000662 Expr *pWhere; /* The WHERE clause */
663 ExprList *pGroupBy; /* The GROUP BY clause */
664 Expr *pHaving; /* The HAVING clause */
665 ExprList *pOrderBy; /* The ORDER BY clause */
drh82c3d632000-06-06 21:56:07 +0000666 int op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
drh967e8b72000-06-21 13:59:10 +0000667 Select *pPrior; /* Prior select in a compound select statement */
drh9bbca4c2001-11-06 04:00:18 +0000668 int nLimit, nOffset; /* LIMIT and OFFSET values. -1 means not used */
drha76b5df2002-02-23 02:32:10 +0000669 char *zSelect; /* Complete text of the SELECT command */
drh832508b2002-03-02 17:04:07 +0000670 int base; /* Index of VDBE cursor for left-most FROM table */
drh9bb61fe2000-06-05 16:01:39 +0000671};
672
673/*
drhfef52082000-06-06 01:50:43 +0000674** The results of a select can be distributed in several ways.
675*/
676#define SRT_Callback 1 /* Invoke a callback with each row of result */
677#define SRT_Mem 2 /* Store result in a memory cell */
drh82c3d632000-06-06 21:56:07 +0000678#define SRT_Set 3 /* Store result as unique keys in a table */
679#define SRT_Union 5 /* Store result as keys in a table */
680#define SRT_Except 6 /* Remove result from a UNION table */
drh5974a302000-06-07 14:42:26 +0000681#define SRT_Table 7 /* Store result as data with a unique key */
drh2d0794e2002-03-03 03:03:52 +0000682#define SRT_TempTable 8 /* Store result in a trasient table */
drhd7489c32002-05-27 12:24:48 +0000683#define SRT_Discard 9 /* Do not save the results anywhere */
drhf46f9052002-06-22 02:33:38 +0000684#define SRT_Sorter 10 /* Store results in the sorter */
drh142e30d2002-08-28 03:00:58 +0000685#define SRT_Subroutine 11 /* Call a subroutine to handle results */
drhfef52082000-06-06 01:50:43 +0000686
687/*
drh22827922000-06-06 17:27:05 +0000688** When a SELECT uses aggregate functions (like "count(*)" or "avg(f1)")
689** we have to do some additional analysis of expressions. An instance
690** of the following structure holds information about a single subexpression
691** somewhere in the SELECT statement. An array of these structures holds
692** all the information we need to generate code for aggregate
693** expressions.
694**
695** Note that when analyzing a SELECT containing aggregates, both
696** non-aggregate field variables and aggregate functions are stored
697** in the AggExpr array of the Parser structure.
698**
699** The pExpr field points to an expression that is part of either the
700** field list, the GROUP BY clause, the HAVING clause or the ORDER BY
701** clause. The expression will be freed when those clauses are cleaned
702** up. Do not try to delete the expression attached to AggExpr.pExpr.
703**
704** If AggExpr.pExpr==0, that means the expression is "count(*)".
705*/
706struct AggExpr {
707 int isAgg; /* if TRUE contains an aggregate function */
708 Expr *pExpr; /* The expression */
drh0bce8352002-02-28 00:41:10 +0000709 FuncDef *pFunc; /* Information about the aggregate function */
drh22827922000-06-06 17:27:05 +0000710};
711
712/*
drhf57b3392001-10-08 13:22:32 +0000713** An SQL parser context. A copy of this structure is passed through
714** the parser and down into all the parser action routine in order to
715** carry around information that is global to the entire parse.
drh75897232000-05-29 14:26:00 +0000716*/
717struct Parse {
718 sqlite *db; /* The main database structure */
drh5e00f6c2001-09-13 13:46:56 +0000719 Btree *pBe; /* The database backend */
drh4c504392000-10-16 22:06:40 +0000720 int rc; /* Return code from execution */
drh75897232000-05-29 14:26:00 +0000721 sqlite_callback xCallback; /* The callback function */
722 void *pArg; /* First argument to the callback function */
723 char *zErrMsg; /* An error message */
724 Token sErrToken; /* The token at which the error occurred */
725 Token sFirstToken; /* The first token parsed */
726 Token sLastToken; /* The last token parsed */
727 Table *pNewTable; /* A table being constructed by CREATE TABLE */
728 Vdbe *pVdbe; /* An engine for executing database bytecode */
drh836faa42003-01-11 13:30:57 +0000729 u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */
drhe0bc4042002-06-25 01:09:11 +0000730 u8 explain; /* True if the EXPLAIN flag is found on the query */
731 u8 initFlag; /* True if reparsing CREATE TABLEs */
732 u8 nameClash; /* A permanent table name clashes with temp table name */
733 u8 useAgg; /* If true, extract field values from the aggregator
734 ** while generating expressions. Normally false */
735 u8 schemaVerified; /* True if an OP_VerifySchema has been coded someplace
736 ** other than after an OP_Transaction */
737 u8 isTemp; /* True if parsing temporary tables */
drhd78eeee2001-09-13 16:18:53 +0000738 int newTnum; /* Table number to use when reparsing CREATE TABLEs */
drh75897232000-05-29 14:26:00 +0000739 int nErr; /* Number of errors seen */
drh832508b2002-03-02 17:04:07 +0000740 int nTab; /* Number of previously allocated VDBE cursors */
drh19a775c2000-06-05 18:54:46 +0000741 int nMem; /* Number of memory cells used so far */
drhfef52082000-06-06 01:50:43 +0000742 int nSet; /* Number of sets used so far */
drh22827922000-06-06 17:27:05 +0000743 int nAgg; /* Number of aggregate expressions */
744 AggExpr *aAgg; /* An array of aggregate expressions */
drhdc379452002-05-15 12:45:43 +0000745 TriggerStack *trigStack;
drh75897232000-05-29 14:26:00 +0000746};
747
danielk1977d99bc932002-05-16 00:13:12 +0000748/*
749 * Each trigger present in the database schema is stored as an instance of
750 * struct Trigger.
751 *
752 * Pointers to instances of struct Trigger are stored in two ways.
753 * 1. In the "trigHash" hash table (part of the sqlite* that represents the
754 * database). This allows Trigger structures to be retrieved by name.
755 * 2. All triggers associated with a single table form a linked list, using the
drhad3cab52002-05-24 02:04:32 +0000756 * pNext member of struct Trigger. A pointer to the first element of the
757 * linked list is stored as the "pTrigger" member of the associated
758 * struct Table.
danielk1977d99bc932002-05-16 00:13:12 +0000759 *
drhad3cab52002-05-24 02:04:32 +0000760 * The "step_list" member points to the first element of a linked list
761 * containing the SQL statements specified as the trigger program.
danielk1977d99bc932002-05-16 00:13:12 +0000762 *
763 * When a trigger is initially created, the "isCommit" member is set to FALSE.
764 * When a transaction is rolled back, any Trigger structures with "isCommit" set
765 * to FALSE are deleted by the logic in sqliteRollbackInternalChanges(). When
766 * a transaction is commited, the "isCommit" member is set to TRUE for any
767 * Trigger structures for which it is FALSE.
768 *
769 * When a trigger is dropped, using the sqliteDropTrigger() interfaced, it is
drhad3cab52002-05-24 02:04:32 +0000770 * removed from the trigHash hash table and added to the trigDrop hash table.
771 * If the transaction is rolled back, the trigger is re-added into the trigHash
danielk1977d99bc932002-05-16 00:13:12 +0000772 * hash table (and hence the database schema). If the transaction is commited,
773 * then the Trigger structure is deleted permanently.
774 */
danielk1977c3f9bad2002-05-15 08:30:12 +0000775struct Trigger {
drhdc379452002-05-15 12:45:43 +0000776 char *name; /* The name of the trigger */
777 char *table; /* The table or view to which the trigger applies */
778 int op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */
danielk1977d99bc932002-05-16 00:13:12 +0000779 int tr_tm; /* One of TK_BEFORE, TK_AFTER */
drhdc379452002-05-15 12:45:43 +0000780 Expr *pWhen; /* The WHEN clause of the expresion (may be NULL) */
781 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger,
danielk1977d99bc932002-05-16 00:13:12 +0000782 the <column-list> is stored here */
drhdc379452002-05-15 12:45:43 +0000783 int foreach; /* One of TK_ROW or TK_STATEMENT */
danielk1977c3f9bad2002-05-15 08:30:12 +0000784
drhdc379452002-05-15 12:45:43 +0000785 TriggerStep *step_list; /* Link list of trigger program steps */
drhdc379452002-05-15 12:45:43 +0000786 Trigger *pNext; /* Next trigger associated with the table */
danielk1977c3f9bad2002-05-15 08:30:12 +0000787};
788
danielk1977d99bc932002-05-16 00:13:12 +0000789/*
790 * An instance of struct TriggerStep is used to store a single SQL statement
791 * that is a part of a trigger-program.
792 *
793 * Instances of struct TriggerStep are stored in a singly linked list (linked
794 * using the "pNext" member) referenced by the "step_list" member of the
795 * associated struct Trigger instance. The first element of the linked list is
796 * the first step of the trigger-program.
797 *
798 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
799 * "SELECT" statement. The meanings of the other members is determined by the
800 * value of "op" as follows:
801 *
802 * (op == TK_INSERT)
803 * orconf -> stores the ON CONFLICT algorithm
804 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then
805 * this stores a pointer to the SELECT statement. Otherwise NULL.
806 * target -> A token holding the name of the table to insert into.
807 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
808 * this stores values to be inserted. Otherwise NULL.
809 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ...
drhad3cab52002-05-24 02:04:32 +0000810 * statement, then this stores the column-names to be
811 * inserted into.
danielk1977d99bc932002-05-16 00:13:12 +0000812 *
813 * (op == TK_DELETE)
814 * target -> A token holding the name of the table to delete from.
815 * pWhere -> The WHERE clause of the DELETE statement if one is specified.
816 * Otherwise NULL.
817 *
818 * (op == TK_UPDATE)
819 * target -> A token holding the name of the table to update rows of.
820 * pWhere -> The WHERE clause of the UPDATE statement if one is specified.
821 * Otherwise NULL.
822 * pExprList -> A list of the columns to update and the expressions to update
drhad3cab52002-05-24 02:04:32 +0000823 * them to. See sqliteUpdate() documentation of "pChanges"
824 * argument.
danielk1977d99bc932002-05-16 00:13:12 +0000825 *
826 */
827struct TriggerStep {
828 int op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
829 int orconf; /* OE_Rollback etc. */
danielk1977c3f9bad2002-05-15 08:30:12 +0000830
danielk1977d99bc932002-05-16 00:13:12 +0000831 Select *pSelect; /* Valid for SELECT and sometimes
832 INSERT steps (when pExprList == 0) */
833 Token target; /* Valid for DELETE, UPDATE, INSERT steps */
834 Expr *pWhere; /* Valid for DELETE, UPDATE steps */
835 ExprList *pExprList; /* Valid for UPDATE statements and sometimes
836 INSERT steps (when pSelect == 0) */
837 IdList *pIdList; /* Valid for INSERT statements only */
838
839 TriggerStep * pNext; /* Next in the link-list */
840};
841
842/*
843 * An instance of struct TriggerStack stores information required during code
844 * generation of a single trigger program. While the trigger program is being
845 * coded, its associated TriggerStack instance is pointed to by the
846 * "pTriggerStack" member of the Parse structure.
847 *
848 * The pTab member points to the table that triggers are being coded on. The
849 * newIdx member contains the index of the vdbe cursor that points at the temp
850 * table that stores the new.* references. If new.* references are not valid
851 * for the trigger being coded (for example an ON DELETE trigger), then newIdx
852 * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
853 *
854 * The ON CONFLICT policy to be used for the trigger program steps is stored
855 * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
856 * specified for individual triggers steps is used.
857 *
858 * struct TriggerStack has a "pNext" member, to allow linked lists to be
859 * constructed. When coding nested triggers (triggers fired by other triggers)
860 * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
861 * pointer. Once the nested trigger has been coded, the pNext value is restored
862 * to the pTriggerStack member of the Parse stucture and coding of the parent
863 * trigger continues.
864 *
865 * Before a nested trigger is coded, the linked list pointed to by the
866 * pTriggerStack is scanned to ensure that the trigger is not about to be coded
867 * recursively. If this condition is detected, the nested trigger is not coded.
868 */
869struct TriggerStack {
870 Table *pTab; /* Table that triggers are currently being coded on */
871 int newIdx; /* Index of vdbe cursor to "new" temp table */
872 int oldIdx; /* Index of vdbe cursor to "old" temp table */
873 int orconf; /* Current orconf policy */
danielk19776f349032002-06-11 02:25:40 +0000874 int ignoreJump; /* where to jump to for a RAISE(IGNORE) */
danielk1977d99bc932002-05-16 00:13:12 +0000875 Trigger *pTrigger;
876
877 TriggerStack *pNext;
878};
879
880/*
881 * This global flag is set for performance testing of triggers. When it is set
882 * SQLite will perform the overhead of building new and old trigger references
883 * even when no triggers exist
884 */
885extern int always_code_trigger_setup;
danielk1977c3f9bad2002-05-15 08:30:12 +0000886
drh75897232000-05-29 14:26:00 +0000887/*
888** Internal function prototypes
889*/
890int sqliteStrICmp(const char *, const char *);
891int sqliteStrNICmp(const char *, const char *, int);
892int sqliteHashNoCase(const char *, int);
893int sqliteCompare(const char *, const char *);
894int sqliteSortCompare(const char *, const char *);
drh9bbca4c2001-11-06 04:00:18 +0000895void sqliteRealToSortable(double r, char *);
drhdcc581c2000-05-30 13:44:19 +0000896#ifdef MEMORY_DEBUG
drh8c1238a2003-01-02 14:43:55 +0000897 void *sqliteMalloc_(int,int,char*,int);
drhdcc581c2000-05-30 13:44:19 +0000898 void sqliteFree_(void*,char*,int);
899 void *sqliteRealloc_(void*,int,char*,int);
drh6e142f52000-06-08 13:36:40 +0000900 char *sqliteStrDup_(const char*,char*,int);
901 char *sqliteStrNDup_(const char*, int,char*,int);
drhdcc581c2000-05-30 13:44:19 +0000902#else
903 void *sqliteMalloc(int);
drh8c1238a2003-01-02 14:43:55 +0000904 void *sqliteMallocRaw(int);
drhdcc581c2000-05-30 13:44:19 +0000905 void sqliteFree(void*);
906 void *sqliteRealloc(void*,int);
drh6e142f52000-06-08 13:36:40 +0000907 char *sqliteStrDup(const char*);
908 char *sqliteStrNDup(const char*, int);
drhdcc581c2000-05-30 13:44:19 +0000909#endif
drh75897232000-05-29 14:26:00 +0000910void sqliteSetString(char **, const char *, ...);
911void sqliteSetNString(char **, ...);
drh982cef72000-05-30 16:27:03 +0000912void sqliteDequote(char*);
drh17f71932002-02-21 12:01:27 +0000913int sqliteKeywordCode(const char*, int);
drh80ff32f2001-11-04 18:32:46 +0000914int sqliteRunParser(Parse*, const char*, char **);
drh75897232000-05-29 14:26:00 +0000915void sqliteExec(Parse*);
916Expr *sqliteExpr(int, Expr*, Expr*, Token*);
drhe1b6a5b2000-07-29 13:06:59 +0000917void sqliteExprSpan(Expr*,Token*,Token*);
drh75897232000-05-29 14:26:00 +0000918Expr *sqliteExprFunction(ExprList*, Token*);
919void sqliteExprDelete(Expr*);
920ExprList *sqliteExprListAppend(ExprList*,Expr*,Token*);
921void sqliteExprListDelete(ExprList*);
drhf57b14a2001-09-14 18:54:08 +0000922void sqlitePragma(Parse*,Token*,Token*,int);
drhe0bc4042002-06-25 01:09:11 +0000923void sqliteResetInternalSchema(sqlite*);
924int sqliteInit(sqlite*, char**);
925void sqliteBeginParse(Parse*,int);
drh5e00f6c2001-09-13 13:46:56 +0000926void sqliteRollbackInternalChanges(sqlite*);
drhe0bc4042002-06-25 01:09:11 +0000927void sqliteCommitInternalChanges(sqlite*);
drh969fa7c2002-02-18 18:30:32 +0000928Table *sqliteResultSetOfSelect(Parse*,char*,Select*);
drhe0bc4042002-06-25 01:09:11 +0000929void sqliteOpenMasterTable(Vdbe *v, int);
drhf57b3392001-10-08 13:22:32 +0000930void sqliteStartTable(Parse*,Token*,Token*,int);
drh75897232000-05-29 14:26:00 +0000931void sqliteAddColumn(Parse*,Token*);
drh9cfcf5d2002-01-29 18:41:24 +0000932void sqliteAddNotNull(Parse*, int);
933void sqliteAddPrimaryKey(Parse*, IdList*, int);
drh382c0242001-10-06 16:33:02 +0000934void sqliteAddColumnType(Parse*,Token*,Token*);
drh7020f652000-06-03 18:06:52 +0000935void sqliteAddDefaultValue(Parse*,Token*,int);
drh8e2ca022002-06-17 17:07:19 +0000936int sqliteCollateType(Parse*, Token*);
937void sqliteAddCollateType(Parse*, int);
drh969fa7c2002-02-18 18:30:32 +0000938void sqliteEndTable(Parse*,Token*,Select*);
drh6276c1c2002-07-08 22:03:32 +0000939void sqliteCreateView(Parse*,Token*,Token*,Select*,int);
drh417be792002-03-03 18:59:40 +0000940int sqliteViewGetColumnNames(Parse*,Table*);
941void sqliteViewResetAll(sqlite*);
drh4ff6dfa2002-03-03 23:06:00 +0000942void sqliteDropTable(Parse*, Token*, int);
drh75897232000-05-29 14:26:00 +0000943void sqliteDeleteTable(sqlite*, Table*);
drh9cfcf5d2002-01-29 18:41:24 +0000944void sqliteInsert(Parse*, Token*, ExprList*, Select*, IdList*, int);
drh75897232000-05-29 14:26:00 +0000945IdList *sqliteIdListAppend(IdList*, Token*);
drhad2d8302002-05-24 20:31:36 +0000946int sqliteIdListIndex(IdList*,const char*);
drhad3cab52002-05-24 02:04:32 +0000947SrcList *sqliteSrcListAppend(SrcList*, Token*);
948void sqliteSrcListAddAlias(SrcList*, Token*);
drh75897232000-05-29 14:26:00 +0000949void sqliteIdListDelete(IdList*);
drhad3cab52002-05-24 02:04:32 +0000950void sqliteSrcListDelete(SrcList*);
drh717e6402001-09-27 03:22:32 +0000951void sqliteCreateIndex(Parse*, Token*, Token*, IdList*, int, Token*, Token*);
drh75897232000-05-29 14:26:00 +0000952void sqliteDropIndex(Parse*, Token*);
drh38640e12002-07-05 21:42:36 +0000953void sqliteAddKeyType(Vdbe*, ExprList*);
954void sqliteAddIdxKeyType(Vdbe*, Index*);
drh1b2e0322002-03-03 02:49:51 +0000955int sqliteSelect(Parse*, Select*, int, int, Select*, int, int*);
drhad3cab52002-05-24 02:04:32 +0000956Select *sqliteSelectNew(ExprList*,SrcList*,Expr*,ExprList*,Expr*,ExprList*,
drh9bbca4c2001-11-06 04:00:18 +0000957 int,int,int);
drh9bb61fe2000-06-05 16:01:39 +0000958void sqliteSelectDelete(Select*);
drhff78bd22002-02-27 01:47:11 +0000959void sqliteSelectUnbind(Select*);
drha76b5df2002-02-23 02:32:10 +0000960Table *sqliteTableNameToTable(Parse*, const char*);
drhad3cab52002-05-24 02:04:32 +0000961SrcList *sqliteTableTokenToSrcList(Parse*, Token*);
drh75897232000-05-29 14:26:00 +0000962void sqliteDeleteFrom(Parse*, Token*, Expr*);
drh9cfcf5d2002-01-29 18:41:24 +0000963void sqliteUpdate(Parse*, Token*, ExprList*, Expr*, int);
drhe3184742002-06-19 14:27:05 +0000964WhereInfo *sqliteWhereBegin(Parse*, int, SrcList*, Expr*, int, ExprList**);
drh75897232000-05-29 14:26:00 +0000965void sqliteWhereEnd(WhereInfo*);
966void sqliteExprCode(Parse*, Expr*);
drhf5905aa2002-05-26 20:54:33 +0000967void sqliteExprIfTrue(Parse*, Expr*, int, int);
968void sqliteExprIfFalse(Parse*, Expr*, int, int);
drha76b5df2002-02-23 02:32:10 +0000969Table *sqliteFindTable(sqlite*,const char*);
970Index *sqliteFindIndex(sqlite*,const char*);
drh6d4abfb2001-10-22 02:58:08 +0000971void sqliteUnlinkAndDeleteIndex(sqlite*,Index*);
drhb419a922002-01-30 16:17:23 +0000972void sqliteCopy(Parse*, Token*, Token*, Token*, int);
drhdce2cbe2000-05-31 02:27:49 +0000973void sqliteVacuum(Parse*, Token*);
drhe17a7e32001-04-04 21:10:18 +0000974int sqliteGlobCompare(const unsigned char*,const unsigned char*);
drhdce2cbe2000-05-31 02:27:49 +0000975int sqliteLikeCompare(const unsigned char*,const unsigned char*);
drhcce7d172000-05-31 15:34:51 +0000976char *sqliteTableNameFromToken(Token*);
977int sqliteExprCheck(Parse*, Expr*, int, int*);
drhc9b84a12002-06-20 11:36:48 +0000978int sqliteExprType(Expr*);
drhd8bc7082000-06-07 23:51:50 +0000979int sqliteExprCompare(Expr*, Expr*);
drhcce7d172000-05-31 15:34:51 +0000980int sqliteFuncId(Token*);
drhad3cab52002-05-24 02:04:32 +0000981int sqliteExprResolveIds(Parse*, int, SrcList*, ExprList*, Expr*);
drh22827922000-06-06 17:27:05 +0000982int sqliteExprAnalyzeAggregates(Parse*, Expr*);
drhd8bc7082000-06-07 23:51:50 +0000983Vdbe *sqliteGetVdbe(Parse*);
drhb8ca3072001-12-05 00:21:20 +0000984int sqliteRandomByte(void);
985int sqliteRandomInteger(void);
drh1c928532002-01-31 15:54:21 +0000986void sqliteBeginTransaction(Parse*, int);
drhc4a3c772001-04-04 11:48:57 +0000987void sqliteCommitTransaction(Parse*);
988void sqliteRollbackTransaction(Parse*);
drh92086432002-01-22 14:11:29 +0000989int sqliteExprIsConstant(Expr*);
drhe4de1fe2002-06-02 16:09:01 +0000990int sqliteExprIsInteger(Expr*, int*);
drha9f9d1c2002-06-29 02:20:08 +0000991int sqliteIsRowid(const char*);
drh38640e12002-07-05 21:42:36 +0000992void sqliteGenerateRowDelete(sqlite*, Vdbe*, Table*, int, int);
993void sqliteGenerateRowIndexDelete(sqlite*, Vdbe*, Table*, int, char*);
drh0ca3e242002-01-29 23:07:02 +0000994void sqliteGenerateConstraintChecks(Parse*,Table*,int,char*,int,int,int,int);
drhb419a922002-01-30 16:17:23 +0000995void sqliteCompleteInsertion(Parse*, Table*, int, char*, int, int);
drhcabb0812002-09-14 13:47:32 +0000996void sqliteBeginWriteOperation(Parse*, int, int);
drh1c928532002-01-31 15:54:21 +0000997void sqliteEndWriteOperation(Parse*);
drhff78bd22002-02-27 01:47:11 +0000998Expr *sqliteExprDup(Expr*);
drh4b59ab52002-08-24 18:24:51 +0000999void sqliteTokenCopy(Token*, Token*);
drhff78bd22002-02-27 01:47:11 +00001000ExprList *sqliteExprListDup(ExprList*);
drhad3cab52002-05-24 02:04:32 +00001001SrcList *sqliteSrcListDup(SrcList*);
drhff78bd22002-02-27 01:47:11 +00001002IdList *sqliteIdListDup(IdList*);
1003Select *sqliteSelectDup(Select*);
drh0bce8352002-02-28 00:41:10 +00001004FuncDef *sqliteFindFunction(sqlite*,const char*,int,int,int);
drh28f4b682002-06-09 10:14:18 +00001005void sqliteRegisterBuiltinFunctions(sqlite*);
drh247be432002-05-10 05:44:55 +00001006int sqliteSafetyOn(sqlite*);
1007int sqliteSafetyOff(sqlite*);
drhc22bd472002-05-10 13:14:07 +00001008int sqliteSafetyCheck(sqlite*);
drhe0bc4042002-06-25 01:09:11 +00001009void sqliteChangeCookie(sqlite*, Vdbe*);
drhdc379452002-05-15 12:45:43 +00001010void sqliteCreateTrigger(Parse*, Token*, int, int, IdList*, Token*,
drh4b59ab52002-08-24 18:24:51 +00001011 int, Expr*, TriggerStep*, Token*);
drhdc379452002-05-15 12:45:43 +00001012void sqliteDropTrigger(Parse*, Token*, int);
1013int sqliteTriggersExist(Parse* , Trigger* , int , int , int, ExprList*);
danielk19776f349032002-06-11 02:25:40 +00001014int sqliteCodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
1015 int, int);
drhdc379452002-05-15 12:45:43 +00001016void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
1017TriggerStep *sqliteTriggerSelectStep(Select*);
1018TriggerStep *sqliteTriggerInsertStep(Token*, IdList*, ExprList*, Select*, int);
1019TriggerStep *sqliteTriggerUpdateStep(Token*, ExprList*, Expr*, int);
1020TriggerStep *sqliteTriggerDeleteStep(Token*, Expr*);
drh1d1f3052002-05-21 13:18:25 +00001021void sqliteDeleteTrigger(Trigger*);
drh01f3f252002-05-24 16:14:15 +00001022int sqliteJoinType(Parse*, Token*, Token*, Token*);
drhc2eef3b2002-08-31 18:53:06 +00001023void sqliteCreateForeignKey(Parse*, IdList*, Token*, IdList*, int);
1024void sqliteDeferForeignKey(Parse*, int);