blob: 302a2b4949c7da54abd27ffa260f1336306c0cc7 [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**
drh5cf8e8c2002-02-19 22:42:05 +000014** @(#) $Id: sqliteInt.h,v 1.88 2002/02/19 22:42:05 drh Exp $
drh75897232000-05-29 14:26:00 +000015*/
16#include "sqlite.h"
drhbeae3192001-09-22 18:12:08 +000017#include "hash.h"
drh75897232000-05-29 14:26:00 +000018#include "vdbe.h"
19#include "parse.h"
drhbe0072d2001-09-13 14:46:09 +000020#include "btree.h"
drh75897232000-05-29 14:26:00 +000021#include <stdio.h>
22#include <stdlib.h>
23#include <string.h>
24#include <assert.h>
25
drh967e8b72000-06-21 13:59:10 +000026/*
drha1b351a2001-09-14 16:42:12 +000027** The maximum number of in-memory pages to use for the main database
28** table and for temporary tables.
29*/
drhf57b14a2001-09-14 18:54:08 +000030#define MAX_PAGES 100
31#define TEMP_PAGES 25
drha1b351a2001-09-14 16:42:12 +000032
33/*
drh4a324312001-12-21 14:30:42 +000034** File format version number
35*/
36#define FILE_FORMAT 1
37
38/*
drh5a2c2c22001-11-21 02:21:11 +000039** Integers of known sizes. These typedefs might change for architectures
40** where the sizes very. Preprocessor macros are available so that the
41** types can be conveniently redefined at compile-type. Like this:
42**
43** cc '-DUINTPTR_TYPE=long long int' ...
drh41a2b482001-01-20 19:52:49 +000044*/
drh5a2c2c22001-11-21 02:21:11 +000045#ifndef UINT32_TYPE
46# define UINT32_TYPE unsigned int
47#endif
48#ifndef UINT16_TYPE
49# define UINT16_TYPE unsigned short int
50#endif
51#ifndef UINT8_TYPE
52# define UINT8_TYPE unsigned char
53#endif
54#ifndef INTPTR_TYPE
55# define INTPTR_TYPE int
56#endif
57typedef UINT32_TYPE u32; /* 4-byte unsigned integer */
58typedef UINT16_TYPE u16; /* 2-byte unsigned integer */
59typedef UINT8_TYPE u8; /* 1-byte unsigned integer */
60typedef INTPTR_TYPE ptr; /* Big enough to hold a pointer */
61typedef unsigned INTPTR_TYPE uptr; /* Big enough to hold a pointer */
62
63/*
64** This macro casts a pointer to an integer. Useful for doing
65** pointer arithmetic.
66*/
67#define Addr(X) ((uptr)X)
drh41a2b482001-01-20 19:52:49 +000068
69/*
drh872ff862001-09-15 14:43:39 +000070** The maximum number of bytes of data that can be put into a single
drh80ff32f2001-11-04 18:32:46 +000071** row of a single table. The upper bound on this limit is 16777215
72** bytes (or 16MB-1). We have arbitrarily set the limit to just 1MB
73** here because the overflow page chain is inefficient for really big
74** records and we want to discourage people from thinking that
75** multi-megabyte records are OK. If your needs are different, you can
76** change this define and recompile to increase or decrease the record
77** size.
drh872ff862001-09-15 14:43:39 +000078*/
drh80ff32f2001-11-04 18:32:46 +000079#define MAX_BYTES_PER_ROW 1048576
drh872ff862001-09-15 14:43:39 +000080
81/*
drh967e8b72000-06-21 13:59:10 +000082** If memory allocation problems are found, recompile with
83**
84** -DMEMORY_DEBUG=1
85**
86** to enable some sanity checking on malloc() and free(). To
87** check for memory leaks, recompile with
88**
89** -DMEMORY_DEBUG=2
90**
91** and a line of text will be written to standard error for
92** each malloc() and free(). This output can be analyzed
93** by an AWK script to determine if there are any leaks.
94*/
drhdcc581c2000-05-30 13:44:19 +000095#ifdef MEMORY_DEBUG
96# define sqliteMalloc(X) sqliteMalloc_(X,__FILE__,__LINE__)
97# define sqliteFree(X) sqliteFree_(X,__FILE__,__LINE__)
98# define sqliteRealloc(X,Y) sqliteRealloc_(X,Y,__FILE__,__LINE__)
drh6e142f52000-06-08 13:36:40 +000099# define sqliteStrDup(X) sqliteStrDup_(X,__FILE__,__LINE__)
100# define sqliteStrNDup(X,Y) sqliteStrNDup_(X,Y,__FILE__,__LINE__)
drhc3c2fc92000-05-31 22:58:39 +0000101 void sqliteStrRealloc(char**);
102#else
103# define sqliteStrRealloc(X)
drhdcc581c2000-05-30 13:44:19 +0000104#endif
105
drh75897232000-05-29 14:26:00 +0000106/*
drhdaffd0e2001-04-11 14:28:42 +0000107** This variable gets set if malloc() ever fails. After it gets set,
108** the SQLite library shuts down permanently.
109*/
110extern int sqlite_malloc_failed;
111
112/*
drh6e142f52000-06-08 13:36:40 +0000113** The following global variables are used for testing and debugging
drh8c82b352000-12-10 18:23:50 +0000114** only. They only work if MEMORY_DEBUG is defined.
drh6e142f52000-06-08 13:36:40 +0000115*/
116#ifdef MEMORY_DEBUG
drh8c82b352000-12-10 18:23:50 +0000117extern int sqlite_nMalloc; /* Number of sqliteMalloc() calls */
118extern int sqlite_nFree; /* Number of sqliteFree() calls */
119extern int sqlite_iMallocFail; /* Fail sqliteMalloc() after this many calls */
drh6e142f52000-06-08 13:36:40 +0000120#endif
121
122/*
drh75897232000-05-29 14:26:00 +0000123** Name of the master database table. The master database table
124** is a special table that holds the names and attributes of all
125** user tables and indices.
126*/
127#define MASTER_NAME "sqlite_master"
128
129/*
130** A convenience macro that returns the number of elements in
131** an array.
132*/
133#define ArraySize(X) (sizeof(X)/sizeof(X[0]))
134
135/*
drh967e8b72000-06-21 13:59:10 +0000136** Integer identifiers for built-in SQL functions.
drhcce7d172000-05-31 15:34:51 +0000137*/
138#define FN_Unknown 0
139#define FN_Count 1
140#define FN_Min 2
141#define FN_Max 3
142#define FN_Sum 4
143#define FN_Avg 5
drh0bdaf622000-06-11 23:50:13 +0000144#define FN_Fcnt 6
drh6ec27332000-08-28 15:51:43 +0000145#define FN_Length 7
146#define FN_Substr 8
drh81a20f22001-10-12 17:30:04 +0000147#define FN_Abs 9
drhbf4133c2001-10-13 02:59:08 +0000148#define FN_Round 10
drhcce7d172000-05-31 15:34:51 +0000149
150/*
drh75897232000-05-29 14:26:00 +0000151** Forward references to structures
152*/
drh7020f652000-06-03 18:06:52 +0000153typedef struct Column Column;
drh75897232000-05-29 14:26:00 +0000154typedef struct Table Table;
155typedef struct Index Index;
156typedef struct Instruction Instruction;
157typedef struct Expr Expr;
158typedef struct ExprList ExprList;
159typedef struct Parse Parse;
160typedef struct Token Token;
161typedef struct IdList IdList;
162typedef struct WhereInfo WhereInfo;
drh6b563442001-11-07 16:48:26 +0000163typedef struct WhereLevel WhereLevel;
drh9bb61fe2000-06-05 16:01:39 +0000164typedef struct Select Select;
drh22827922000-06-06 17:27:05 +0000165typedef struct AggExpr AggExpr;
drh75897232000-05-29 14:26:00 +0000166
167/*
168** Each database is an instance of the following structure
169*/
170struct sqlite {
drh5e00f6c2001-09-13 13:46:56 +0000171 Btree *pBe; /* The B*Tree backend */
drhf57b3392001-10-08 13:22:32 +0000172 Btree *pBeTemp; /* Backend for session temporary tables */
drh5e00f6c2001-09-13 13:46:56 +0000173 int flags; /* Miscellanous flags. See below */
174 int file_format; /* What file format version is this database? */
drh50e5dad2001-09-15 00:57:28 +0000175 int schema_cookie; /* Magic number that changes with the schema */
176 int next_cookie; /* Value of schema_cookie after commit */
drh5e00f6c2001-09-13 13:46:56 +0000177 int nTable; /* Number of tables in the database */
178 void *pBusyArg; /* 1st Argument to the busy callback */
drh353f57e2000-08-02 12:26:28 +0000179 int (*xBusyCallback)(void *,const char*,int); /* The busy callback */
drhbeae3192001-09-22 18:12:08 +0000180 Hash tblHash; /* All tables indexed by name */
181 Hash idxHash; /* All (named) indices indexed by name */
drh74e24cd2002-01-09 03:19:59 +0000182 Hash tblDrop; /* Uncommitted DROP TABLEs */
183 Hash idxDrop; /* Uncommitted DROP INDEXs */
drhaf9ff332002-01-16 21:00:27 +0000184 int lastRowid; /* ROWID of most recent insert */
drh5cf8e8c2002-02-19 22:42:05 +0000185 int priorNewRowid; /* Last randomly generated ROWID */
drh1c928532002-01-31 15:54:21 +0000186 int onError; /* Default conflict algorithm */
drh75897232000-05-29 14:26:00 +0000187};
188
189/*
drh967e8b72000-06-21 13:59:10 +0000190** Possible values for the sqlite.flags.
drh75897232000-05-29 14:26:00 +0000191*/
drh5e00f6c2001-09-13 13:46:56 +0000192#define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */
193#define SQLITE_Initialized 0x00000002 /* True after initialization */
194#define SQLITE_Interrupt 0x00000004 /* Cancel current operation */
195#define SQLITE_InTrans 0x00000008 /* True if in a transaction */
196#define SQLITE_InternChanges 0x00000010 /* Uncommitted Hash table changes */
drh382c0242001-10-06 16:33:02 +0000197#define SQLITE_FullColNames 0x00000020 /* Show full column names on SELECT */
drh1bee3d72001-10-15 00:44:35 +0000198#define SQLITE_CountRows 0x00000040 /* Count rows changed by INSERT, */
199 /* DELETE, or UPDATE and return */
200 /* the count using a callback. */
drh6a535342001-10-19 16:44:56 +0000201#define SQLITE_NullCallback 0x00000080 /* Invoke the callback once if the */
202 /* result set is empty */
drhc3a64ba2001-11-22 00:01:27 +0000203#define SQLITE_ResultDetails 0x00000100 /* Details added to result set */
drh58b95762000-06-02 01:17:37 +0000204
205/*
drh28037572000-08-02 13:47:41 +0000206** Current file format version
207*/
208#define SQLITE_FileFormat 2
209
210/*
drh967e8b72000-06-21 13:59:10 +0000211** information about each column of an SQL table is held in an instance
drh7020f652000-06-03 18:06:52 +0000212** of this structure.
213*/
214struct Column {
drh967e8b72000-06-21 13:59:10 +0000215 char *zName; /* Name of this column */
216 char *zDflt; /* Default value of this column */
drh382c0242001-10-06 16:33:02 +0000217 char *zType; /* Data type for this column */
drh4a324312001-12-21 14:30:42 +0000218 u8 notNull; /* True if there is a NOT NULL constraint */
219 u8 isPrimKey; /* True if this column is an INTEGER PRIMARY KEY */
drh7020f652000-06-03 18:06:52 +0000220};
221
222/*
drh22f70c32002-02-18 01:17:00 +0000223** Each SQL table is represented in memory by an instance of the
224** following structure.
225**
226** Expr.zName is the name of the table. The case of the original
227** CREATE TABLE statement is stored, but case is not significant for
228** comparisons.
229**
230** Expr.nCol is the number of columns in this table. Expr.aCol is a
231** pointer to an array of Column structures, one for each column.
232**
233** If the table has an INTEGER PRIMARY KEY, then Expr.iPKey is the index of
234** the column that is that key. Otherwise Expr.iPKey is negative. Note
235** that the datatype of the PRIMARY KEY must be INTEGER for this field to
236** be set. An INTEGER PRIMARY KEY is used as the rowid for each row of
237** the table. If a table has no INTEGER PRIMARY KEY, then a random rowid
238** is generated for each row of the table. Expr.hasPrimKey is true if
239** the table has any PRIMARY KEY, INTEGER or otherwise.
240**
241** Expr.tnum is the page number for the root BTree page of the table in the
242** database file. If Expr.isTemp is true, then this page occurs in the
243** auxiliary database file, not the main database file. If Expr.isTransient
244** is true, then the table is stored in a file that is automatically deleted
245** when the VDBE cursor to the table is closed. In this case Expr.tnum
246** refers VDBE cursor number that holds the table open, not to the root
247** page number. Transient tables are used to hold the results of a
248** sub-query that appears instead of a real table name in the FROM clause
249** of a SELECT statement.
drh75897232000-05-29 14:26:00 +0000250*/
251struct Table {
drh967e8b72000-06-21 13:59:10 +0000252 char *zName; /* Name of the table */
drh967e8b72000-06-21 13:59:10 +0000253 int nCol; /* Number of columns in this table */
254 Column *aCol; /* Information about each column */
drhc8392582001-12-31 02:48:51 +0000255 int iPKey; /* If not less then 0, use aCol[iPKey] as the primary key */
drh967e8b72000-06-21 13:59:10 +0000256 Index *pIndex; /* List of SQL indexes on this table. */
drh22f70c32002-02-18 01:17:00 +0000257 int tnum; /* Root BTree node for this table (see note above) */
drh717e6402001-09-27 03:22:32 +0000258 u8 readOnly; /* True if this table should not be written by the user */
259 u8 isCommit; /* True if creation of this table has been committed */
drhf57b3392001-10-08 13:22:32 +0000260 u8 isTemp; /* True if stored in db->pBeTemp instead of db->pBe */
drh22f70c32002-02-18 01:17:00 +0000261 u8 isTransient; /* True if automatically deleted when VDBE finishes */
drh4a324312001-12-21 14:30:42 +0000262 u8 hasPrimKey; /* True if there exists a primary key */
drh9cfcf5d2002-01-29 18:41:24 +0000263 u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */
drh75897232000-05-29 14:26:00 +0000264};
265
266/*
drh22f70c32002-02-18 01:17:00 +0000267** SQLite supports 5 different ways to resolve a contraint
268** error. ROLLBACK processing means that a constraint violation
drh1c928532002-01-31 15:54:21 +0000269** causes the operation in proces to fail and for the current transaction
270** to be rolled back. ABORT processing means the operation in process
271** fails and any prior changes from that one operation are backed out,
272** but the transaction is not rolled back. FAIL processing means that
273** the operation in progress stops and returns an error code. But prior
274** changes due to the same operation are not backed out and no rollback
275** occurs. IGNORE means that the particular row that caused the constraint
276** error is not inserted or updated. Processing continues and no error
277** is returned. REPLACE means that preexisting database rows that caused
278** a UNIQUE constraint violation are removed so that the new insert or
279** update can proceed. Processing continues and no error is reported.
280**
281** The following there symbolic values are used to record which type
282** of action to take.
drh9cfcf5d2002-01-29 18:41:24 +0000283*/
drh1c928532002-01-31 15:54:21 +0000284#define OE_None 0 /* There is no constraint to check */
285#define OE_Rollback 1 /* Fail the operation and rollback the transaction */
286#define OE_Abort 2 /* Back out changes but do no rollback transaction */
287#define OE_Fail 3 /* Stop the operation but leave all prior changes */
288#define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */
289#define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */
290#define OE_Default 9 /* Do whatever the default action is */
drh9cfcf5d2002-01-29 18:41:24 +0000291
292/*
drh66b89c82000-11-28 20:47:17 +0000293** Each SQL index is represented in memory by an
drh75897232000-05-29 14:26:00 +0000294** instance of the following structure.
drh967e8b72000-06-21 13:59:10 +0000295**
296** The columns of the table that are to be indexed are described
297** by the aiColumn[] field of this structure. For example, suppose
298** we have the following table and index:
299**
300** CREATE TABLE Ex1(c1 int, c2 int, c3 text);
301** CREATE INDEX Ex2 ON Ex1(c3,c1);
302**
303** In the Table structure describing Ex1, nCol==3 because there are
304** three columns in the table. In the Index structure describing
305** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
306** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the
307** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
308** The second column to be indexed (c1) has an index of 0 in
309** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
drh75897232000-05-29 14:26:00 +0000310*/
311struct Index {
drh967e8b72000-06-21 13:59:10 +0000312 char *zName; /* Name of this index */
drh967e8b72000-06-21 13:59:10 +0000313 int nColumn; /* Number of columns in the table used by this index */
314 int *aiColumn; /* Which columns are used by this index. 1st is 0 */
315 Table *pTable; /* The SQL table being indexed */
drhbe0072d2001-09-13 14:46:09 +0000316 int tnum; /* Page containing root of this index in database file */
drh9cfcf5d2002-01-29 18:41:24 +0000317 u8 isUnique; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
drh717e6402001-09-27 03:22:32 +0000318 u8 isCommit; /* True if creation of this index has been committed */
drh74e24cd2002-01-09 03:19:59 +0000319 u8 isDropped; /* True if a DROP INDEX has executed on this index */
drh9cfcf5d2002-01-29 18:41:24 +0000320 u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
drh967e8b72000-06-21 13:59:10 +0000321 Index *pNext; /* The next index associated with the same table */
drh75897232000-05-29 14:26:00 +0000322};
323
324/*
325** Each token coming out of the lexer is an instance of
326** this structure.
327*/
328struct Token {
drh80ff32f2001-11-04 18:32:46 +0000329 const char *z; /* Text of the token. Not NULL-terminated! */
330 int n; /* Number of characters in this token */
drh75897232000-05-29 14:26:00 +0000331};
332
333/*
334** Each node of an expression in the parse tree is an instance
drh22f70c32002-02-18 01:17:00 +0000335** of this structure.
336**
337** Expr.op is the opcode. The integer parser token codes are reused
338** as opcodes here. For example, the parser defines TK_GE to be an integer
339** code representing the ">=" operator. This same integer code is reused
340** to represent the greater-than-or-equal-to operator in the expression
341** tree.
342**
343** Expr.pRight and Expr.pLeft are subexpressions. Expr.pList is a list
344** of argument if the expression is a function.
345**
346** Expr.token is the operator token for this node. Expr.span is the complete
347** subexpression represented by this node and all its decendents. These
348** fields are used for error reporting and for reconstructing the text of
349** an expression to use as the column name in a SELECT statement.
350**
351** An expression of the form ID or ID.ID refers to a column in a table.
352** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
353** the integer cursor number of a VDBE cursor pointing to that table and
354** Expr.iColumn is the column number for the specific column. If the
355** expression is used as a result in an aggregate SELECT, then the
356** value is also stored in the Expr.iAgg column in the aggregate so that
357** it can be accessed after all aggregates are computed.
358**
359** If the expression is a function, the Expr.iTable is an integer code
360** representing which function.
361**
362** The Expr.pSelect field points to a SELECT statement. The SELECT might
363** be the right operand of an IN operator. Or, if a scalar SELECT appears
364** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
365** operand.
drh75897232000-05-29 14:26:00 +0000366*/
367struct Expr {
368 int op; /* Operation performed by this node */
369 Expr *pLeft, *pRight; /* Left and right subnodes */
370 ExprList *pList; /* A list of expressions used as a function argument */
371 Token token; /* An operand token */
drhe1b6a5b2000-07-29 13:06:59 +0000372 Token span; /* Complete text of the expression */
drh967e8b72000-06-21 13:59:10 +0000373 int iTable, iColumn; /* When op==TK_COLUMN, then this expr node means the
374 ** iColumn-th field of the iTable-th table. When
375 ** op==TK_FUNCTION, iColumn holds the function id */
376 int iAgg; /* When op==TK_COLUMN and pParse->useAgg==TRUE, pull
377 ** result from the iAgg-th element of the aggregator */
drh19a775c2000-06-05 18:54:46 +0000378 Select *pSelect; /* When the expression is a sub-select */
drh75897232000-05-29 14:26:00 +0000379};
380
381/*
382** A list of expressions. Each expression may optionally have a
383** name. An expr/name combination can be used in several ways, such
384** as the list of "expr AS ID" fields following a "SELECT" or in the
385** list of "ID = expr" items in an UPDATE. A list of expressions can
386** also be used as the argument to a function, in which case the azName
387** field is not used.
388*/
389struct ExprList {
390 int nExpr; /* Number of expressions on the list */
drh6d4abfb2001-10-22 02:58:08 +0000391 struct ExprList_item {
drh75897232000-05-29 14:26:00 +0000392 Expr *pExpr; /* The list of expressions */
393 char *zName; /* Token associated with this expression */
drhd8bc7082000-06-07 23:51:50 +0000394 char sortOrder; /* 1 for DESC or 0 for ASC */
395 char isAgg; /* True if this is an aggregate like count(*) */
396 char done; /* A flag to indicate when processing is finished */
drh75897232000-05-29 14:26:00 +0000397 } *a; /* One entry for each expression */
398};
399
400/*
401** A list of identifiers.
402*/
403struct IdList {
404 int nId; /* Number of identifiers on the list */
drh6d4abfb2001-10-22 02:58:08 +0000405 struct IdList_item {
drh75897232000-05-29 14:26:00 +0000406 char *zName; /* Text of the identifier. */
407 char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */
drh967e8b72000-06-21 13:59:10 +0000408 int idx; /* Index in some Table.aCol[] of a column named zName */
drhdaffd0e2001-04-11 14:28:42 +0000409 Table *pTab; /* An SQL table corresponding to zName */
410 Select *pSelect; /* A SELECT statement used in place of a table name */
drh75897232000-05-29 14:26:00 +0000411 } *a; /* One entry for each identifier on the list */
412};
413
414/*
drh6b563442001-11-07 16:48:26 +0000415** For each nested loop in a WHERE clause implementation, the WhereInfo
416** structure contains a single instance of this structure. This structure
417** is intended to be private the the where.c module and should not be
418** access or modified by other modules.
419*/
420struct WhereLevel {
421 int iMem; /* Memory cell used by this level */
422 Index *pIdx; /* Index used */
423 int iCur; /* Cursor number used for this index */
drh487ab3c2001-11-08 00:45:21 +0000424 int score; /* How well this indexed scored */
drh6b563442001-11-07 16:48:26 +0000425 int brk; /* Jump here to break out of the loop */
426 int cont; /* Jump here to continue with the next loop cycle */
427 int op, p1, p2; /* Opcode used to terminate the loop */
428};
429
430/*
drh75897232000-05-29 14:26:00 +0000431** The WHERE clause processing routine has two halves. The
432** first part does the start of the WHERE loop and the second
433** half does the tail of the WHERE loop. An instance of
434** this structure is returned by the first half and passed
435** into the second half to give some continuity.
436*/
437struct WhereInfo {
438 Parse *pParse;
drh19a775c2000-06-05 18:54:46 +0000439 IdList *pTabList; /* List of tables in the join */
440 int iContinue; /* Jump here to continue with next record */
441 int iBreak; /* Jump here to break out of the loop */
442 int base; /* Index of first Open opcode */
drh6b563442001-11-07 16:48:26 +0000443 int nLevel; /* Number of nested loop */
444 WhereLevel a[1]; /* Information about each nest loop in the WHERE */
drh75897232000-05-29 14:26:00 +0000445};
446
447/*
drh9bb61fe2000-06-05 16:01:39 +0000448** An instance of the following structure contains all information
449** needed to generate code for a single SELECT statement.
450*/
451struct Select {
452 int isDistinct; /* True if the DISTINCT keyword is present */
453 ExprList *pEList; /* The fields of the result */
454 IdList *pSrc; /* The FROM clause */
455 Expr *pWhere; /* The WHERE clause */
456 ExprList *pGroupBy; /* The GROUP BY clause */
457 Expr *pHaving; /* The HAVING clause */
458 ExprList *pOrderBy; /* The ORDER BY clause */
drh82c3d632000-06-06 21:56:07 +0000459 int op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
drh967e8b72000-06-21 13:59:10 +0000460 Select *pPrior; /* Prior select in a compound select statement */
drh9bbca4c2001-11-06 04:00:18 +0000461 int nLimit, nOffset; /* LIMIT and OFFSET values. -1 means not used */
drh9bb61fe2000-06-05 16:01:39 +0000462};
463
464/*
drhfef52082000-06-06 01:50:43 +0000465** The results of a select can be distributed in several ways.
466*/
467#define SRT_Callback 1 /* Invoke a callback with each row of result */
468#define SRT_Mem 2 /* Store result in a memory cell */
drh82c3d632000-06-06 21:56:07 +0000469#define SRT_Set 3 /* Store result as unique keys in a table */
470#define SRT_Union 5 /* Store result as keys in a table */
471#define SRT_Except 6 /* Remove result from a UNION table */
drh5974a302000-06-07 14:42:26 +0000472#define SRT_Table 7 /* Store result as data with a unique key */
drhfef52082000-06-06 01:50:43 +0000473
474/*
drh22827922000-06-06 17:27:05 +0000475** When a SELECT uses aggregate functions (like "count(*)" or "avg(f1)")
476** we have to do some additional analysis of expressions. An instance
477** of the following structure holds information about a single subexpression
478** somewhere in the SELECT statement. An array of these structures holds
479** all the information we need to generate code for aggregate
480** expressions.
481**
482** Note that when analyzing a SELECT containing aggregates, both
483** non-aggregate field variables and aggregate functions are stored
484** in the AggExpr array of the Parser structure.
485**
486** The pExpr field points to an expression that is part of either the
487** field list, the GROUP BY clause, the HAVING clause or the ORDER BY
488** clause. The expression will be freed when those clauses are cleaned
489** up. Do not try to delete the expression attached to AggExpr.pExpr.
490**
491** If AggExpr.pExpr==0, that means the expression is "count(*)".
492*/
493struct AggExpr {
494 int isAgg; /* if TRUE contains an aggregate function */
495 Expr *pExpr; /* The expression */
496};
497
498/*
drhf57b3392001-10-08 13:22:32 +0000499** An SQL parser context. A copy of this structure is passed through
500** the parser and down into all the parser action routine in order to
501** carry around information that is global to the entire parse.
drh75897232000-05-29 14:26:00 +0000502*/
503struct Parse {
504 sqlite *db; /* The main database structure */
drh5e00f6c2001-09-13 13:46:56 +0000505 Btree *pBe; /* The database backend */
drh4c504392000-10-16 22:06:40 +0000506 int rc; /* Return code from execution */
drh75897232000-05-29 14:26:00 +0000507 sqlite_callback xCallback; /* The callback function */
508 void *pArg; /* First argument to the callback function */
509 char *zErrMsg; /* An error message */
510 Token sErrToken; /* The token at which the error occurred */
511 Token sFirstToken; /* The first token parsed */
512 Token sLastToken; /* The last token parsed */
513 Table *pNewTable; /* A table being constructed by CREATE TABLE */
514 Vdbe *pVdbe; /* An engine for executing database bytecode */
drhd8bc7082000-06-07 23:51:50 +0000515 int colNamesSet; /* TRUE after OP_ColumnCount has been issued to pVdbe */
drh75897232000-05-29 14:26:00 +0000516 int explain; /* True if the EXPLAIN flag is found on the query */
517 int initFlag; /* True if reparsing CREATE TABLEs */
drhf57b3392001-10-08 13:22:32 +0000518 int nameClash; /* A permanent table name clashes with temp table name */
drhd78eeee2001-09-13 16:18:53 +0000519 int newTnum; /* Table number to use when reparsing CREATE TABLEs */
drh75897232000-05-29 14:26:00 +0000520 int nErr; /* Number of errors seen */
drh19a775c2000-06-05 18:54:46 +0000521 int nTab; /* Number of previously allocated cursors */
522 int nMem; /* Number of memory cells used so far */
drhfef52082000-06-06 01:50:43 +0000523 int nSet; /* Number of sets used so far */
drh22827922000-06-06 17:27:05 +0000524 int nAgg; /* Number of aggregate expressions */
525 AggExpr *aAgg; /* An array of aggregate expressions */
526 int iAggCount; /* Index of the count(*) aggregate in aAgg[] */
527 int useAgg; /* If true, extract field values from the aggregator
528 ** while generating expressions. Normally false */
drh50e5dad2001-09-15 00:57:28 +0000529 int schemaVerified; /* True if an OP_VerifySchema has been coded someplace
530 ** other than after an OP_Transaction */
drh75897232000-05-29 14:26:00 +0000531};
532
533/*
534** Internal function prototypes
535*/
536int sqliteStrICmp(const char *, const char *);
537int sqliteStrNICmp(const char *, const char *, int);
538int sqliteHashNoCase(const char *, int);
539int sqliteCompare(const char *, const char *);
540int sqliteSortCompare(const char *, const char *);
drh9bbca4c2001-11-06 04:00:18 +0000541void sqliteRealToSortable(double r, char *);
drhdcc581c2000-05-30 13:44:19 +0000542#ifdef MEMORY_DEBUG
543 void *sqliteMalloc_(int,char*,int);
544 void sqliteFree_(void*,char*,int);
545 void *sqliteRealloc_(void*,int,char*,int);
drh6e142f52000-06-08 13:36:40 +0000546 char *sqliteStrDup_(const char*,char*,int);
547 char *sqliteStrNDup_(const char*, int,char*,int);
drhdcc581c2000-05-30 13:44:19 +0000548#else
549 void *sqliteMalloc(int);
550 void sqliteFree(void*);
551 void *sqliteRealloc(void*,int);
drh6e142f52000-06-08 13:36:40 +0000552 char *sqliteStrDup(const char*);
553 char *sqliteStrNDup(const char*, int);
drhdcc581c2000-05-30 13:44:19 +0000554#endif
drh75897232000-05-29 14:26:00 +0000555void sqliteSetString(char **, const char *, ...);
556void sqliteSetNString(char **, ...);
drh982cef72000-05-30 16:27:03 +0000557void sqliteDequote(char*);
drh80ff32f2001-11-04 18:32:46 +0000558int sqliteRunParser(Parse*, const char*, char **);
drh75897232000-05-29 14:26:00 +0000559void sqliteExec(Parse*);
560Expr *sqliteExpr(int, Expr*, Expr*, Token*);
drhe1b6a5b2000-07-29 13:06:59 +0000561void sqliteExprSpan(Expr*,Token*,Token*);
drh75897232000-05-29 14:26:00 +0000562Expr *sqliteExprFunction(ExprList*, Token*);
563void sqliteExprDelete(Expr*);
564ExprList *sqliteExprListAppend(ExprList*,Expr*,Token*);
565void sqliteExprListDelete(ExprList*);
drhf57b14a2001-09-14 18:54:08 +0000566void sqlitePragma(Parse*,Token*,Token*,int);
drh5e00f6c2001-09-13 13:46:56 +0000567void sqliteCommitInternalChanges(sqlite*);
568void sqliteRollbackInternalChanges(sqlite*);
drh969fa7c2002-02-18 18:30:32 +0000569Table *sqliteResultSetOfSelect(Parse*,char*,Select*);
drhf57b3392001-10-08 13:22:32 +0000570void sqliteStartTable(Parse*,Token*,Token*,int);
drh75897232000-05-29 14:26:00 +0000571void sqliteAddColumn(Parse*,Token*);
drh9cfcf5d2002-01-29 18:41:24 +0000572void sqliteAddNotNull(Parse*, int);
573void sqliteAddPrimaryKey(Parse*, IdList*, int);
drh382c0242001-10-06 16:33:02 +0000574void sqliteAddColumnType(Parse*,Token*,Token*);
drh7020f652000-06-03 18:06:52 +0000575void sqliteAddDefaultValue(Parse*,Token*,int);
drh969fa7c2002-02-18 18:30:32 +0000576void sqliteEndTable(Parse*,Token*,Select*);
drh75897232000-05-29 14:26:00 +0000577void sqliteDropTable(Parse*, Token*);
578void sqliteDeleteTable(sqlite*, Table*);
drh9cfcf5d2002-01-29 18:41:24 +0000579void sqliteInsert(Parse*, Token*, ExprList*, Select*, IdList*, int);
drh75897232000-05-29 14:26:00 +0000580IdList *sqliteIdListAppend(IdList*, Token*);
581void sqliteIdListAddAlias(IdList*, Token*);
582void sqliteIdListDelete(IdList*);
drh717e6402001-09-27 03:22:32 +0000583void sqliteCreateIndex(Parse*, Token*, Token*, IdList*, int, Token*, Token*);
drh75897232000-05-29 14:26:00 +0000584void sqliteDropIndex(Parse*, Token*);
drh19a775c2000-06-05 18:54:46 +0000585int sqliteSelect(Parse*, Select*, int, int);
drh9bbca4c2001-11-06 04:00:18 +0000586Select *sqliteSelectNew(ExprList*,IdList*,Expr*,ExprList*,Expr*,ExprList*,
587 int,int,int);
drh9bb61fe2000-06-05 16:01:39 +0000588void sqliteSelectDelete(Select*);
drh75897232000-05-29 14:26:00 +0000589void sqliteDeleteFrom(Parse*, Token*, Expr*);
drh9cfcf5d2002-01-29 18:41:24 +0000590void sqliteUpdate(Parse*, Token*, ExprList*, Expr*, int);
drh75897232000-05-29 14:26:00 +0000591WhereInfo *sqliteWhereBegin(Parse*, IdList*, Expr*, int);
592void sqliteWhereEnd(WhereInfo*);
593void sqliteExprCode(Parse*, Expr*);
594void sqliteExprIfTrue(Parse*, Expr*, int);
595void sqliteExprIfFalse(Parse*, Expr*, int);
596Table *sqliteFindTable(sqlite*,char*);
drhadbca9c2001-09-27 15:11:53 +0000597Index *sqliteFindIndex(sqlite*,char*);
drh6d4abfb2001-10-22 02:58:08 +0000598void sqliteUnlinkAndDeleteIndex(sqlite*,Index*);
drhb419a922002-01-30 16:17:23 +0000599void sqliteCopy(Parse*, Token*, Token*, Token*, int);
drhdce2cbe2000-05-31 02:27:49 +0000600void sqliteVacuum(Parse*, Token*);
drhe17a7e32001-04-04 21:10:18 +0000601int sqliteGlobCompare(const unsigned char*,const unsigned char*);
drhdce2cbe2000-05-31 02:27:49 +0000602int sqliteLikeCompare(const unsigned char*,const unsigned char*);
drhcce7d172000-05-31 15:34:51 +0000603char *sqliteTableNameFromToken(Token*);
604int sqliteExprCheck(Parse*, Expr*, int, int*);
drhd8bc7082000-06-07 23:51:50 +0000605int sqliteExprCompare(Expr*, Expr*);
drhcce7d172000-05-31 15:34:51 +0000606int sqliteFuncId(Token*);
drha2e00042002-01-22 03:13:42 +0000607int sqliteExprResolveIds(Parse*, IdList*, ExprList*, Expr*);
drh4794b982000-06-06 13:54:14 +0000608void sqliteExprResolveInSelect(Parse*, Expr*);
drh22827922000-06-06 17:27:05 +0000609int sqliteExprAnalyzeAggregates(Parse*, Expr*);
drhd8bc7082000-06-07 23:51:50 +0000610Vdbe *sqliteGetVdbe(Parse*);
drhb8ca3072001-12-05 00:21:20 +0000611int sqliteRandomByte(void);
612int sqliteRandomInteger(void);
drh1c928532002-01-31 15:54:21 +0000613void sqliteBeginTransaction(Parse*, int);
drhc4a3c772001-04-04 11:48:57 +0000614void sqliteCommitTransaction(Parse*);
615void sqliteRollbackTransaction(Parse*);
drhd1bf3512001-04-07 15:24:33 +0000616char *sqlite_mprintf(const char *, ...);
drh92086432002-01-22 14:11:29 +0000617int sqliteExprIsConstant(Expr*);
drh0ca3e242002-01-29 23:07:02 +0000618void sqliteGenerateRowDelete(Vdbe*, Table*, int);
619void sqliteGenerateRowIndexDelete(Vdbe*, Table*, int, char*);
620void sqliteGenerateConstraintChecks(Parse*,Table*,int,char*,int,int,int,int);
drhb419a922002-01-30 16:17:23 +0000621void sqliteCompleteInsertion(Parse*, Table*, int, char*, int, int);
drh1c928532002-01-31 15:54:21 +0000622void sqliteBeginWriteOperation(Parse*);
drh663fc632002-02-02 18:49:19 +0000623void sqliteBeginMultiWriteOperation(Parse*);
drh1c928532002-01-31 15:54:21 +0000624void sqliteEndWriteOperation(Parse*);