blob: b9e2ac8540684d31b329365aa5ce54f406d11778 [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**
danielk1977eecfb3e2006-01-10 12:31:39 +000014** @(#) $Id: sqliteInt.h,v 1.458 2006/01/10 12:31:40 danielk1977 Exp $
drh75897232000-05-29 14:26:00 +000015*/
danielk1977e3026632004-06-22 11:29:02 +000016#ifndef _SQLITEINT_H_
17#define _SQLITEINT_H_
18
drheb206252004-10-01 02:00:31 +000019/*
drh824d7c12006-01-06 12:03:19 +000020** Extra interface definitions for those who need them
21*/
22#ifdef SQLITE_EXTRA
23# include "sqliteExtra.h"
24#endif
25
26/*
drh4b529d92005-09-13 00:00:00 +000027** Many people are failing to set -DNDEBUG=1 when compiling SQLite.
drhb27795c2005-09-13 00:02:16 +000028** Setting NDEBUG makes the code smaller and run faster. So the following
drh4b529d92005-09-13 00:00:00 +000029** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1
30** option is set. Thus NDEBUG becomes an opt-in rather than an opt-out
31** feature.
32*/
drh289ab072005-09-13 16:12:47 +000033#if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
drh4b529d92005-09-13 00:00:00 +000034# define NDEBUG 1
35#endif
36
37/*
drheb206252004-10-01 02:00:31 +000038** These #defines should enable >2GB file support on Posix if the
39** underlying operating system supports it. If the OS lacks
40** large file support, or if the OS is windows, these should be no-ops.
41**
42** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
43** on the compiler command line. This is necessary if you are compiling
44** on a recent machine (ex: RedHat 7.2) but you want your code to work
45** on an older machine (ex: RedHat 6.0). If you compile on RedHat 7.2
46** without this option, LFS is enable. But LFS does not exist in the kernel
47** in RedHat 6.0, so the code won't work. Hence, for maximum binary
48** portability you should omit LFS.
49**
50** Similar is true for MacOS. LFS is only supported on MacOS 9 and later.
51*/
52#ifndef SQLITE_DISABLE_LFS
53# define _LARGE_FILE 1
54# ifndef _FILE_OFFSET_BITS
55# define _FILE_OFFSET_BITS 64
56# endif
57# define _LARGEFILE_SOURCE 1
58#endif
59
drh1d482dd2004-05-31 18:23:07 +000060#include "sqlite3.h"
drhbeae3192001-09-22 18:12:08 +000061#include "hash.h"
drh75897232000-05-29 14:26:00 +000062#include "parse.h"
drh75897232000-05-29 14:26:00 +000063#include <stdio.h>
64#include <stdlib.h>
65#include <string.h>
66#include <assert.h>
drh52370e22005-01-21 21:31:40 +000067#include <stddef.h>
drh75897232000-05-29 14:26:00 +000068
drh967e8b72000-06-21 13:59:10 +000069/*
drhb37df7b2005-10-13 02:09:49 +000070** If compiling for a processor that lacks floating point support,
71** substitute integer for floating-point
72*/
73#ifdef SQLITE_OMIT_FLOATING_POINT
74# define double sqlite_int64
75# define LONGDOUBLE_TYPE sqlite_int64
76# define SQLITE_BIG_DBL (0x7fffffffffffffff)
77# define SQLITE_OMIT_DATETIME_FUNCS 1
78# define SQLITE_OMIT_TRACE 1
79#endif
80
81/*
drha1b351a2001-09-14 16:42:12 +000082** The maximum number of in-memory pages to use for the main database
danielk197724c8ab82005-02-09 01:40:23 +000083** table and for temporary tables. Internally, the MAX_PAGES and
84** TEMP_PAGES macros are used. To override the default values at
85** compilation time, the SQLITE_DEFAULT_CACHE_SIZE and
86** SQLITE_DEFAULT_TEMP_CACHE_SIZE macros should be set.
drha1b351a2001-09-14 16:42:12 +000087*/
drh1ba1e6e2005-01-21 21:22:52 +000088#ifdef SQLITE_DEFAULT_CACHE_SIZE
89# define MAX_PAGES SQLITE_DEFAULT_CACHE_SIZE
90#else
91# define MAX_PAGES 2000
92#endif
danielk197724c8ab82005-02-09 01:40:23 +000093#ifdef SQLITE_DEFAULT_TEMP_CACHE_SIZE
94# define TEMP_PAGES SQLITE_DEFAULT_TEMP_CACHE_SIZE
95#else
96# define TEMP_PAGES 500
97#endif
drha1b351a2001-09-14 16:42:12 +000098
99/*
danielk197753c0f742005-03-29 03:10:59 +0000100** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
101** afterward. Having this macro allows us to cause the C compiler
102** to omit code used by TEMP tables without messy #ifndef statements.
103*/
104#ifdef SQLITE_OMIT_TEMPDB
105#define OMIT_TEMPDB 1
106#else
107#define OMIT_TEMPDB 0
108#endif
109
110/*
drh0bd1f4e2002-06-06 18:54:39 +0000111** If the following macro is set to 1, then NULL values are considered
112** distinct for the SELECT DISTINCT statement and for UNION or EXCEPT
113** compound queries. No other SQL database engine (among those tested)
114** works this way except for OCELOT. But the SQL92 spec implies that
115** this is how things should work.
116**
117** If the following macro is set to 0, then NULLs are indistinct for
118** SELECT DISTINCT and for UNION.
119*/
120#define NULL_ALWAYS_DISTINCT 0
121
122/*
123** If the following macro is set to 1, then NULL values are considered
124** distinct when determining whether or not two entries are the same
125** in a UNIQUE index. This is the way PostgreSQL, Oracle, DB2, MySQL,
126** OCELOT, and Firebird all work. The SQL92 spec explicitly says this
127** is the way things are suppose to work.
128**
129** If the following macro is set to 0, the NULLs are indistinct for
130** a UNIQUE index. In this mode, you can only have a single NULL entry
131** for a column declared UNIQUE. This is the way Informix and SQL Server
132** work.
133*/
134#define NULL_DISTINCT_FOR_UNIQUE 1
135
136/*
drh665de472003-03-31 13:36:09 +0000137** The maximum number of attached databases. This must be at least 2
138** in order to support the main database file (0) and the file used to
drh80242052004-06-09 00:48:12 +0000139** hold temporary tables (1). And it must be less than 32 because
140** we use a bitmask of databases with a u32 in places (for example
141** the Parse.cookieMask field).
drh665de472003-03-31 13:36:09 +0000142*/
143#define MAX_ATTACHED 10
144
145/*
drhfa6bc002004-09-07 16:19:52 +0000146** The maximum value of a ?nnn wildcard that the parser will accept.
147*/
148#define SQLITE_MAX_VARIABLE_NUMBER 999
149
150/*
drhd946db02005-12-29 19:23:06 +0000151** The "file format" number is an integer that is incremented whenever
152** the VDBE-level file format changes. The following macros define the
153** the default file format for new databases and the maximum file format
154** that the library can read.
155*/
156#define SQLITE_MAX_FILE_FORMAT 4
157#ifndef SQLITE_DEFAULT_FILE_FORMAT
158# define SQLITE_DEFAULT_FILE_FORMAT 4
159#endif
160
161/*
drh49766d62005-01-08 18:42:28 +0000162** Provide a default value for TEMP_STORE in case it is not specified
163** on the command-line
164*/
165#ifndef TEMP_STORE
166# define TEMP_STORE 1
167#endif
168
169/*
drhf1974842004-11-05 03:56:00 +0000170** GCC does not define the offsetof() macro so we'll have to do it
171** ourselves.
172*/
173#ifndef offsetof
174#define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
175#endif
176
177/*
drh5a2c2c22001-11-21 02:21:11 +0000178** Integers of known sizes. These typedefs might change for architectures
179** where the sizes very. Preprocessor macros are available so that the
180** types can be conveniently redefined at compile-type. Like this:
181**
182** cc '-DUINTPTR_TYPE=long long int' ...
drh41a2b482001-01-20 19:52:49 +0000183*/
drh3aac2dd2004-04-26 14:10:20 +0000184#ifndef UINT64_TYPE
drhefad9992004-06-22 12:13:55 +0000185# if defined(_MSC_VER) || defined(__BORLANDC__)
186# define UINT64_TYPE unsigned __int64
187# else
188# define UINT64_TYPE unsigned long long int
189# endif
drh3aac2dd2004-04-26 14:10:20 +0000190#endif
drh5a2c2c22001-11-21 02:21:11 +0000191#ifndef UINT32_TYPE
192# define UINT32_TYPE unsigned int
193#endif
194#ifndef UINT16_TYPE
195# define UINT16_TYPE unsigned short int
196#endif
drh939a16d2004-07-15 13:37:22 +0000197#ifndef INT16_TYPE
198# define INT16_TYPE short int
199#endif
drh5a2c2c22001-11-21 02:21:11 +0000200#ifndef UINT8_TYPE
201# define UINT8_TYPE unsigned char
202#endif
drh905793e2004-02-21 13:31:09 +0000203#ifndef INT8_TYPE
204# define INT8_TYPE signed char
205#endif
drhefad9992004-06-22 12:13:55 +0000206#ifndef LONGDOUBLE_TYPE
207# define LONGDOUBLE_TYPE long double
208#endif
drhefad9992004-06-22 12:13:55 +0000209typedef sqlite_int64 i64; /* 8-byte signed integer */
drh3aac2dd2004-04-26 14:10:20 +0000210typedef UINT64_TYPE u64; /* 8-byte unsigned integer */
drh5a2c2c22001-11-21 02:21:11 +0000211typedef UINT32_TYPE u32; /* 4-byte unsigned integer */
212typedef UINT16_TYPE u16; /* 2-byte unsigned integer */
drh939a16d2004-07-15 13:37:22 +0000213typedef INT16_TYPE i16; /* 2-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000214typedef UINT8_TYPE u8; /* 1-byte unsigned integer */
drh905793e2004-02-21 13:31:09 +0000215typedef UINT8_TYPE i8; /* 1-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000216
217/*
drhbbd42a62004-05-22 17:41:58 +0000218** Macros to determine whether the machine is big or little endian,
219** evaluated at runtime.
220*/
221extern const int sqlite3one;
drh9c054832004-05-31 18:51:57 +0000222#define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0)
223#define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
drhbbd42a62004-05-22 17:41:58 +0000224
225/*
drh90f5ecb2004-07-22 01:19:35 +0000226** An instance of the following structure is used to store the busy-handler
227** callback for a given sqlite handle.
228**
229** The sqlite.busyHandler member of the sqlite struct contains the busy
230** callback for the database handle. Each pager opened via the sqlite
231** handle is passed a pointer to sqlite.busyHandler. The busy-handler
232** callback is currently invoked only from within pager.c.
233*/
234typedef struct BusyHandler BusyHandler;
235struct BusyHandler {
236 int (*xFunc)(void *,int); /* The busy callback */
237 void *pArg; /* First arg to busy callback */
drha4afb652005-07-09 02:16:02 +0000238 int nBusy; /* Incremented with each busy call */
drh90f5ecb2004-07-22 01:19:35 +0000239};
240
241/*
242** Defer sourcing vdbe.h and btree.h until after the "u8" and
243** "BusyHandler typedefs.
drh905793e2004-02-21 13:31:09 +0000244*/
245#include "vdbe.h"
drh3aac2dd2004-04-26 14:10:20 +0000246#include "btree.h"
danielk197713f72992005-12-18 08:51:22 +0000247#include "pager.h"
drh905793e2004-02-21 13:31:09 +0000248
249/*
drh5a2c2c22001-11-21 02:21:11 +0000250** This macro casts a pointer to an integer. Useful for doing
251** pointer arithmetic.
252*/
253#define Addr(X) ((uptr)X)
drh41a2b482001-01-20 19:52:49 +0000254
danielk19772c336542005-01-13 02:14:23 +0000255#ifdef SQLITE_MEMDEBUG
drh75897232000-05-29 14:26:00 +0000256/*
drh6e142f52000-06-08 13:36:40 +0000257** The following global variables are used for testing and debugging
danielk1977c00da102006-01-07 13:21:04 +0000258** only. They only work if SQLITE_MEMDEBUG is defined.
drh6e142f52000-06-08 13:36:40 +0000259*/
drh46934232004-11-20 19:18:00 +0000260extern int sqlite3_nMalloc; /* Number of sqliteMalloc() calls */
261extern int sqlite3_nFree; /* Number of sqliteFree() calls */
262extern int sqlite3_iMallocFail; /* Fail sqliteMalloc() after this many calls */
263extern int sqlite3_iMallocReset; /* Set iMallocFail to this when it reaches 0 */
danielk19772e588c72005-12-09 14:25:08 +0000264#define ENTER_MALLOC (\
danielk1977e501b892006-01-09 06:29:47 +0000265 sqlite3ThreadData()->zFile = __FILE__, sqlite3ThreadData()->iLine = __LINE__ \
danielk19772e588c72005-12-09 14:25:08 +0000266)
danielk1977c00da102006-01-07 13:21:04 +0000267#define sqliteMalloc(x) (ENTER_MALLOC, sqlite3Malloc(x))
268#define sqliteMallocRaw(x) (ENTER_MALLOC, sqlite3MallocRaw(x))
269#define sqliteRealloc(x,y) (ENTER_MALLOC, sqlite3Realloc(x,y))
270#define sqliteStrDup(x) (ENTER_MALLOC, sqlite3StrDup(x))
271#define sqliteStrNDup(x,y) (ENTER_MALLOC, sqlite3StrNDup(x,y))
272#define sqliteReallocOrFree(x,y) (ENTER_MALLOC, sqlite3ReallocOrFree(x,y))
danielk19772e588c72005-12-09 14:25:08 +0000273
danielk197797cb2e92005-12-09 14:39:04 +0000274#else
275
danielk1977c00da102006-01-07 13:21:04 +0000276#define sqliteMalloc(x) sqlite3Malloc(x)
277#define sqliteMallocRaw(x) sqlite3MallocRaw(x)
278#define sqliteRealloc(x,y) sqlite3Realloc(x,y)
279#define sqliteStrDup(x) sqlite3StrDup(x)
280#define sqliteStrNDup(x,y) sqlite3StrNDup(x,y)
281#define sqliteReallocOrFree(x,y) sqlite3ReallocOrFree(x,y)
danielk197797cb2e92005-12-09 14:39:04 +0000282
283#endif
284
danielk197713f72992005-12-18 08:51:22 +0000285#define sqliteFree(x) sqlite3FreeX(x)
286#define sqliteAllocSize(x) sqlite3AllocSize(x)
danielk197797cb2e92005-12-09 14:39:04 +0000287
danielk19772e588c72005-12-09 14:25:08 +0000288/*
289** An instance of this structure is allocated for each thread that uses SQLite.
290*/
danielk1977e501b892006-01-09 06:29:47 +0000291struct ThreadData {
danielk19775591df52005-12-20 09:19:37 +0000292 u8 isInit; /* True if structure has been initialised */
293 u8 mallocFailed; /* True after a malloc() has failed */
294
danielk197713f72992005-12-18 08:51:22 +0000295#ifndef SQLITE_OMIT_MEMORY_MANAGEMENT
danielk197752622822006-01-09 09:59:49 +0000296 u8 useMemoryManagement; /* True if memory-management is enabled */
drhd78901d2006-01-05 23:42:50 +0000297 i64 nSoftHeapLimit; /* Suggested max mem allocation. No limit if <0 */
danielk19775591df52005-12-20 09:19:37 +0000298 i64 nAlloc; /* Number of bytes currently allocated */
299 Pager *pPager; /* Linked list of all pagers in this thread */
danielk19777ddad962005-12-12 06:53:03 +0000300#endif
301
danielk1977aef0bf62005-12-30 16:28:01 +0000302#ifndef SQLITE_OMIT_SHARED_CACHE
303 u8 useSharedData; /* True if shared pagers and schemas are enabled */
drhd78901d2006-01-05 23:42:50 +0000304 BtShared *pBtree; /* Linked list of all currently open BTrees */
danielk1977aef0bf62005-12-30 16:28:01 +0000305#endif
306
danielk19772e588c72005-12-09 14:25:08 +0000307#ifdef SQLITE_MEMDEBUG
danielk1977e501b892006-01-09 06:29:47 +0000308 i64 nMaxAlloc; /* High water mark of ThreadData.nAlloc */
danielk19775591df52005-12-20 09:19:37 +0000309 int mallocAllowed; /* assert() in sqlite3Malloc() if not set */
danielk19772e588c72005-12-09 14:25:08 +0000310 int isFail; /* True if all malloc() calls should fail */
311 const char *zFile; /* Filename to associate debugging info with */
312 int iLine; /* Line number to associate debugging info with */
313 void *pFirst; /* Pointer to linked list of allocations */
314#endif
315};
316
drh6e142f52000-06-08 13:36:40 +0000317/*
drh75897232000-05-29 14:26:00 +0000318** Name of the master database table. The master database table
319** is a special table that holds the names and attributes of all
320** user tables and indices.
321*/
drhe0bc4042002-06-25 01:09:11 +0000322#define MASTER_NAME "sqlite_master"
323#define TEMP_MASTER_NAME "sqlite_temp_master"
drh75897232000-05-29 14:26:00 +0000324
325/*
danielk19778e150812004-05-10 01:17:37 +0000326** The root-page of the master database table.
327*/
328#define MASTER_ROOT 1
329
330/*
drhed6c8672003-01-12 18:02:16 +0000331** The name of the schema table.
332*/
danielk197753c0f742005-03-29 03:10:59 +0000333#define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
drhed6c8672003-01-12 18:02:16 +0000334
335/*
drh75897232000-05-29 14:26:00 +0000336** A convenience macro that returns the number of elements in
337** an array.
338*/
339#define ArraySize(X) (sizeof(X)/sizeof(X[0]))
340
341/*
342** Forward references to structures
343*/
drh13449892005-09-07 21:22:45 +0000344typedef struct AggInfo AggInfo;
drhfe05af82005-07-21 03:14:59 +0000345typedef struct AuthContext AuthContext;
346typedef struct CollSeq CollSeq;
drh7020f652000-06-03 18:06:52 +0000347typedef struct Column Column;
drhfe05af82005-07-21 03:14:59 +0000348typedef struct Db Db;
danielk1977e501b892006-01-09 06:29:47 +0000349typedef struct Schema Schema;
drh75897232000-05-29 14:26:00 +0000350typedef struct Expr Expr;
351typedef struct ExprList ExprList;
drhc2eef3b2002-08-31 18:53:06 +0000352typedef struct FKey FKey;
drhfe05af82005-07-21 03:14:59 +0000353typedef struct FuncDef FuncDef;
354typedef struct IdList IdList;
355typedef struct Index Index;
danielk19778d059842004-05-12 11:24:02 +0000356typedef struct KeyClass KeyClass;
drhd3d39e92004-05-20 22:16:29 +0000357typedef struct KeyInfo KeyInfo;
drh626a8792005-01-17 22:08:19 +0000358typedef struct NameContext NameContext;
drhfe05af82005-07-21 03:14:59 +0000359typedef struct Parse Parse;
360typedef struct Select Select;
361typedef struct SrcList SrcList;
danielk1977e501b892006-01-09 06:29:47 +0000362typedef struct ThreadData ThreadData;
drhfe05af82005-07-21 03:14:59 +0000363typedef struct Table Table;
danielk1977c00da102006-01-07 13:21:04 +0000364typedef struct TableLock TableLock;
drhfe05af82005-07-21 03:14:59 +0000365typedef struct Token Token;
366typedef struct TriggerStack TriggerStack;
367typedef struct TriggerStep TriggerStep;
368typedef struct Trigger Trigger;
drhfe05af82005-07-21 03:14:59 +0000369typedef struct WhereInfo WhereInfo;
370typedef struct WhereLevel WhereLevel;
drhd3d39e92004-05-20 22:16:29 +0000371
drh001bbcb2003-03-19 03:14:00 +0000372/*
373** Each database file to be accessed by the system is an instance
374** of the following structure. There are normally two of these structures
375** in the sqlite.aDb[] array. aDb[0] is the main database file and
drha69d9162003-04-17 22:57:53 +0000376** aDb[1] is the database file used to hold temporary tables. Additional
377** databases may be attached.
drh001bbcb2003-03-19 03:14:00 +0000378*/
379struct Db {
380 char *zName; /* Name of this database */
381 Btree *pBt; /* The B*Tree structure for this database file */
danielk1977da184232006-01-05 11:34:32 +0000382 u8 inTrans; /* 0: not writable. 1: Transaction. 2: Checkpoint */
383 u8 safety_level; /* How aggressive at synching data to disk */
danielk1977da184232006-01-05 11:34:32 +0000384 void *pAux; /* Auxiliary data. Usually NULL */
385 void (*xFreeAux)(void*); /* Routine to free pAux */
danielk1977e501b892006-01-09 06:29:47 +0000386 Schema *pSchema; /* Pointer to database schema (possibly shared) */
danielk1977da184232006-01-05 11:34:32 +0000387};
388
389/*
390** An instance of the following structure stores a database schema.
391*/
danielk1977e501b892006-01-09 06:29:47 +0000392struct Schema {
drh001bbcb2003-03-19 03:14:00 +0000393 int schema_cookie; /* Database schema version number for this file */
drhd24cc422003-03-27 12:51:24 +0000394 Hash tblHash; /* All tables indexed by name */
395 Hash idxHash; /* All (named) indices indexed by name */
396 Hash trigHash; /* All triggers indexed by name */
397 Hash aFKey; /* Foreign keys indexed by to-table */
drh4794f732004-11-05 17:17:50 +0000398 Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */
danielk1977da184232006-01-05 11:34:32 +0000399 u8 file_format; /* Schema format version for this file */
400 u16 flags; /* Flags associated with this schema */
danielk197714db2662006-01-09 16:12:04 +0000401 int cache_size; /* Number of pages to use in the cache */
402 u8 enc; /* Text encoding used by this database */
drh001bbcb2003-03-19 03:14:00 +0000403};
drh75897232000-05-29 14:26:00 +0000404
405/*
drh8bf8dc92003-05-17 17:35:10 +0000406** These macros can be used to test, set, or clear bits in the
407** Db.flags field.
408*/
danielk1977da184232006-01-05 11:34:32 +0000409#define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))==(P))
410#define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))!=0)
411#define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->flags|=(P)
412#define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->flags&=~(P)
drh8bf8dc92003-05-17 17:35:10 +0000413
414/*
415** Allowed values for the DB.flags field.
416**
drh8bf8dc92003-05-17 17:35:10 +0000417** The DB_SchemaLoaded flag is set after the database schema has been
418** read into internal hash tables.
419**
420** DB_UnresetViews means that one or more views have column names that
421** have been filled out. If the schema changes, these column names might
422** changes and so the view will need to be reset.
423*/
drh124b27e2004-06-19 16:06:10 +0000424#define DB_SchemaLoaded 0x0001 /* The schema has been loaded */
425#define DB_UnresetViews 0x0002 /* Some views have defined column names */
drh8bf8dc92003-05-17 17:35:10 +0000426
danielk1977dc8453f2004-06-12 00:42:34 +0000427#define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
drh8bf8dc92003-05-17 17:35:10 +0000428
429/*
drhc9b84a12002-06-20 11:36:48 +0000430** Each database is an instance of the following structure.
431**
rdcb0c374f2004-02-20 22:53:38 +0000432** The sqlite.lastRowid records the last insert rowid generated by an
433** insert statement. Inserts on views do not affect its value. Each
434** trigger has its own context, so that lastRowid can be updated inside
435** triggers as usual. The previous value will be restored once the trigger
436** exits. Upon entering a before or instead of trigger, lastRowid is no
437** longer (since after version 2.8.12) reset to -1.
438**
439** The sqlite.nChange does not count changes within triggers and keeps no
danielk19776f8a5032004-05-10 10:34:51 +0000440** context. It is reset at start of sqlite3_exec.
rdcb0c374f2004-02-20 22:53:38 +0000441** The sqlite.lsChange represents the number of changes made by the last
442** insert, update, or delete statement. It remains constant throughout the
443** length of a statement and is then updated by OP_SetCounts. It keeps a
444** context stack just like lastRowid so that the count of changes
445** within a trigger is not seen outside the trigger. Changes to views do not
446** affect the value of lsChange.
447** The sqlite.csChange keeps track of the number of current changes (since
448** the last statement) and is used to update sqlite_lsChange.
danielk19776622cce2004-05-20 11:00:52 +0000449**
450** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
451** store the most recent error code and, if applicable, string. The
452** internal function sqlite3Error() is used to set these variables
453** consistently.
drh75897232000-05-29 14:26:00 +0000454*/
drh9bb575f2004-09-06 17:24:11 +0000455struct sqlite3 {
drh001bbcb2003-03-19 03:14:00 +0000456 int nDb; /* Number of backends currently in use */
457 Db *aDb; /* All backends */
drh5e00f6c2001-09-13 13:46:56 +0000458 int flags; /* Miscellanous flags. See below */
drhfcd35c72005-05-21 02:48:08 +0000459 int errCode; /* Most recent error code (SQLITE_*) */
drhfcd35c72005-05-21 02:48:08 +0000460 u8 autoCommit; /* The auto-commit flag. */
drh90f5ecb2004-07-22 01:19:35 +0000461 u8 temp_store; /* 1: file 2: memory 0: default */
drh5e00f6c2001-09-13 13:46:56 +0000462 int nTable; /* Number of tables in the database */
drhd3d39e92004-05-20 22:16:29 +0000463 CollSeq *pDfltColl; /* The default collating sequence (BINARY) */
drhf328bc82004-05-10 23:29:49 +0000464 i64 lastRowid; /* ROWID of most recent insert (see above) */
465 i64 priorNewRowid; /* Last randomly generated ROWID */
drh247be432002-05-10 05:44:55 +0000466 int magic; /* Magic number for detect library misuse */
danielk1977b28af712004-06-21 06:50:26 +0000467 int nChange; /* Value returned by sqlite3_changes() */
468 int nTotalChange; /* Value returned by sqlite3_total_changes() */
469 struct sqlite3InitInfo { /* Information used during initialization */
470 int iDb; /* When back is being initialized */
471 int newTnum; /* Rootpage of table being initialized */
472 u8 busy; /* TRUE if currently initializing */
drh1d85d932004-02-14 23:05:52 +0000473 } init;
drh326dce72003-01-29 14:06:07 +0000474 struct Vdbe *pVdbe; /* List of active virtual machines */
danielk19771d850a72004-05-31 08:26:49 +0000475 int activeVdbeCnt; /* Number of vdbes currently executing */
drh19e2d372005-08-29 23:00:03 +0000476 void (*xTrace)(void*,const char*); /* Trace function */
477 void *pTraceArg; /* Argument to the trace function */
478 void (*xProfile)(void*,const char*,u64); /* Profiling function */
479 void *pProfileArg; /* Argument to profile function */
danielk197771fd80b2005-12-16 06:54:01 +0000480 void *pCommitArg; /* Argument to xCommitCallback() */
481 int (*xCommitCallback)(void*); /* Invoked at every commit. */
482 void *pRollbackArg; /* Argument to xRollbackCallback() */
483 void (*xRollbackCallback)(void*); /* Invoked at every commit. */
danielk197794eb6a12005-12-15 15:22:08 +0000484 void *pUpdateArg;
485 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
drhfcd35c72005-05-21 02:48:08 +0000486 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
487 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
488 void *pCollNeededArg;
drhfcd35c72005-05-21 02:48:08 +0000489 sqlite3_value *pErr; /* Most recent error message */
490 char *zErrMsg; /* Most recent error message (UTF-8 encoded) */
491 char *zErrMsg16; /* Most recent error message (UTF-16 encoded) */
drhed6c8672003-01-12 18:02:16 +0000492#ifndef SQLITE_OMIT_AUTHORIZATION
drhe22a3342003-04-22 20:30:37 +0000493 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
494 /* Access authorization function */
drhed6c8672003-01-12 18:02:16 +0000495 void *pAuthArg; /* 1st argument to the access auth function */
496#endif
danielk1977348bb5d2003-10-18 09:37:26 +0000497#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
498 int (*xProgress)(void *); /* The progress callback */
499 void *pProgressArg; /* Argument to the progress callback */
500 int nProgressOps; /* Number of opcodes for progress callback */
501#endif
danielk19776b456a22005-03-21 04:04:02 +0000502#ifndef SQLITE_OMIT_GLOBALRECOVER
503 sqlite3 *pNext; /* Linked list of open db handles. */
504#endif
drhfcd35c72005-05-21 02:48:08 +0000505 Hash aFunc; /* All functions that can be in SQL exprs */
506 Hash aCollSeq; /* All collating sequences */
507 BusyHandler busyHandler; /* Busy callback */
drh97903fe2005-05-24 20:19:57 +0000508 int busyTimeout; /* Busy handler timeout, in msec */
drhfcd35c72005-05-21 02:48:08 +0000509 Db aDbStatic[2]; /* Static space for the 2 default backends */
danielk19777e900ab2005-05-23 04:51:01 +0000510#ifdef SQLITE_SSE
511 sqlite3_stmt *pFetch; /* Used by SSE to fetch stored statements */
512#endif
drh75897232000-05-29 14:26:00 +0000513};
514
danielk197714db2662006-01-09 16:12:04 +0000515#define ENC(db) ((db)->aDb[0].pSchema->enc)
516
drh75897232000-05-29 14:26:00 +0000517/*
drh8bf8dc92003-05-17 17:35:10 +0000518** Possible values for the sqlite.flags and or Db.flags fields.
519**
520** On sqlite.flags, the SQLITE_InTrans value means that we have
521** executed a BEGIN. On Db.flags, SQLITE_InTrans means a statement
522** transaction is active on that particular database file.
drh75897232000-05-29 14:26:00 +0000523*/
drh5e00f6c2001-09-13 13:46:56 +0000524#define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */
525#define SQLITE_Initialized 0x00000002 /* True after initialization */
526#define SQLITE_Interrupt 0x00000004 /* Cancel current operation */
527#define SQLITE_InTrans 0x00000008 /* True if in a transaction */
528#define SQLITE_InternChanges 0x00000010 /* Uncommitted Hash table changes */
drh382c0242001-10-06 16:33:02 +0000529#define SQLITE_FullColNames 0x00000020 /* Show full column names on SELECT */
drhfcabd462004-02-20 14:50:58 +0000530#define SQLITE_ShortColNames 0x00000040 /* Show short columns names */
531#define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */
drh1bee3d72001-10-15 00:44:35 +0000532 /* DELETE, or UPDATE and return */
533 /* the count using a callback. */
drhfcabd462004-02-20 14:50:58 +0000534#define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */
drh6a535342001-10-19 16:44:56 +0000535 /* result set is empty */
drh35d4c2f2004-06-10 01:30:59 +0000536#define SQLITE_SqlTrace 0x00000200 /* Debug print SQL as it executes */
537#define SQLITE_VdbeListing 0x00000400 /* Debug listings of VDBE programs */
drhf4040832004-10-22 20:29:21 +0000538#define SQLITE_WriteSchema 0x00000800 /* OK to update SQLITE_MASTER */
drh7bec5052005-02-06 02:45:41 +0000539#define SQLITE_NoReadlock 0x00001000 /* Readlocks are omitted when
540 ** accessing read-only databases */
drh0cd2d4c2005-11-03 02:15:02 +0000541#define SQLITE_IgnoreChecks 0x00002000 /* Do not enforce check constraints */
danielk1977da184232006-01-05 11:34:32 +0000542#define SQLITE_ReadUncommitted 0x00004000 /* For shared-cache mode */
drh58b95762000-06-02 01:17:37 +0000543
544/*
drh247be432002-05-10 05:44:55 +0000545** Possible values for the sqlite.magic field.
546** The numbers are obtained at random and have no special meaning, other
547** than being distinct from one another.
548*/
549#define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */
550#define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */
551#define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */
552#define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */
553
554/*
drh0bce8352002-02-28 00:41:10 +0000555** Each SQL function is defined by an instance of the following
556** structure. A pointer to this structure is stored in the sqlite.aFunc
drh8e0a2f92002-02-23 23:45:45 +0000557** hash table. When multiple functions have the same name, the hash table
558** points to a linked list of these structures.
drh28037572000-08-02 13:47:41 +0000559*/
drh0bce8352002-02-28 00:41:10 +0000560struct FuncDef {
drh55ef4d92005-08-14 01:20:37 +0000561 i16 nArg; /* Number of arguments. -1 means unlimited */
danielk1977d8123362004-06-12 09:25:12 +0000562 u8 iPrefEnc; /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
drh55ef4d92005-08-14 01:20:37 +0000563 u8 needCollSeq; /* True if sqlite3GetFuncCollSeq() might be called */
564 u8 flags; /* Some combination of SQLITE_FUNC_* */
drhf9b596e2004-05-26 16:54:42 +0000565 void *pUserData; /* User data parameter */
566 FuncDef *pNext; /* Next function with same name */
567 void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
568 void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
569 void (*xFinalize)(sqlite3_context*); /* Aggregate finializer */
drh55ef4d92005-08-14 01:20:37 +0000570 char zName[1]; /* SQL name of the function. MUST BE LAST */
drh8e0a2f92002-02-23 23:45:45 +0000571};
drh28037572000-08-02 13:47:41 +0000572
573/*
drh55ef4d92005-08-14 01:20:37 +0000574** Possible values for FuncDef.flags
575*/
drhd64fe2f2005-08-28 17:00:23 +0000576#define SQLITE_FUNC_LIKE 0x01 /* Candidate for the LIKE optimization */
577#define SQLITE_FUNC_CASE 0x02 /* Case-sensitive LIKE-type function */
drh55ef4d92005-08-14 01:20:37 +0000578
579/*
drh967e8b72000-06-21 13:59:10 +0000580** information about each column of an SQL table is held in an instance
drh7020f652000-06-03 18:06:52 +0000581** of this structure.
582*/
583struct Column {
drh967e8b72000-06-21 13:59:10 +0000584 char *zName; /* Name of this column */
danielk19777977a172004-11-09 12:44:37 +0000585 Expr *pDflt; /* Default value of this column */
drh382c0242001-10-06 16:33:02 +0000586 char *zType; /* Data type for this column */
drha9fd84b2004-05-18 23:21:35 +0000587 CollSeq *pColl; /* Collating sequence. If NULL, use the default */
drh4a324312001-12-21 14:30:42 +0000588 u8 notNull; /* True if there is a NOT NULL constraint */
drh78100cc2003-08-23 22:40:53 +0000589 u8 isPrimKey; /* True if this column is part of the PRIMARY KEY */
danielk1977a37cdde2004-05-16 11:15:36 +0000590 char affinity; /* One of the SQLITE_AFF_... values */
drh7020f652000-06-03 18:06:52 +0000591};
592
593/*
drha9fd84b2004-05-18 23:21:35 +0000594** A "Collating Sequence" is defined by an instance of the following
danielk19770202b292004-06-09 09:55:16 +0000595** structure. Conceptually, a collating sequence consists of a name and
596** a comparison routine that defines the order of that sequence.
drha9fd84b2004-05-18 23:21:35 +0000597**
danielk19770202b292004-06-09 09:55:16 +0000598** There may two seperate implementations of the collation function, one
599** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
600** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
601** native byte order. When a collation sequence is invoked, SQLite selects
602** the version that will require the least expensive encoding
603** transalations, if any.
604**
605** The CollSeq.pUser member variable is an extra parameter that passed in
606** as the first argument to the UTF-8 comparison function, xCmp.
607** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
608** xCmp16.
609**
610** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
611** collating sequence is undefined. Indices built on an undefined
612** collating sequence may not be read or written.
drha9fd84b2004-05-18 23:21:35 +0000613*/
614struct CollSeq {
danielk19770202b292004-06-09 09:55:16 +0000615 char *zName; /* Name of the collating sequence, UTF-8 encoded */
danielk1977466be562004-06-10 02:16:01 +0000616 u8 enc; /* Text encoding handled by xCmp() */
drhd64fe2f2005-08-28 17:00:23 +0000617 u8 type; /* One of the SQLITE_COLL_... values below */
drha9fd84b2004-05-18 23:21:35 +0000618 void *pUser; /* First argument to xCmp() */
danielk19770202b292004-06-09 09:55:16 +0000619 int (*xCmp)(void*,int, const void*, int, const void*);
drha9fd84b2004-05-18 23:21:35 +0000620};
621
622/*
drhd64fe2f2005-08-28 17:00:23 +0000623** Allowed values of CollSeq flags:
624*/
625#define SQLITE_COLL_BINARY 1 /* The default memcmp() collating sequence */
626#define SQLITE_COLL_NOCASE 2 /* The built-in NOCASE collating sequence */
627#define SQLITE_COLL_REVERSE 3 /* The built-in REVERSE collating sequence */
628#define SQLITE_COLL_USER 0 /* Any other user-defined collating sequence */
629
630/*
drhd3d39e92004-05-20 22:16:29 +0000631** A sort order can be either ASC or DESC.
drh8e2ca022002-06-17 17:07:19 +0000632*/
drh8e2ca022002-06-17 17:07:19 +0000633#define SQLITE_SO_ASC 0 /* Sort in ascending order */
drhd3d39e92004-05-20 22:16:29 +0000634#define SQLITE_SO_DESC 1 /* Sort in ascending order */
drh8e2ca022002-06-17 17:07:19 +0000635
636/*
danielk1977a37cdde2004-05-16 11:15:36 +0000637** Column affinity types.
drh8a512562005-11-14 22:29:05 +0000638**
639** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
640** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve
641** the speed a little by number the values consecutively.
642**
643** But rather than start with 0 or 1, we begin with 'a'. That way,
644** when multiple affinity types are concatenated into a string and
645** used as the P3 operand, they will be more readable.
646**
647** Note also that the numeric types are grouped together so that testing
648** for a numeric type is a single comparison.
danielk1977a37cdde2004-05-16 11:15:36 +0000649*/
drh8a512562005-11-14 22:29:05 +0000650#define SQLITE_AFF_TEXT 'a'
651#define SQLITE_AFF_NONE 'b'
652#define SQLITE_AFF_NUMERIC 'c'
653#define SQLITE_AFF_INTEGER 'd'
654#define SQLITE_AFF_REAL 'e'
danielk1977a37cdde2004-05-16 11:15:36 +0000655
drh8a512562005-11-14 22:29:05 +0000656#define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC)
danielk1977a37cdde2004-05-16 11:15:36 +0000657
658/*
drh22f70c32002-02-18 01:17:00 +0000659** Each SQL table is represented in memory by an instance of the
660** following structure.
661**
drhd24cc422003-03-27 12:51:24 +0000662** Table.zName is the name of the table. The case of the original
drh22f70c32002-02-18 01:17:00 +0000663** CREATE TABLE statement is stored, but case is not significant for
664** comparisons.
665**
drhd24cc422003-03-27 12:51:24 +0000666** Table.nCol is the number of columns in this table. Table.aCol is a
drh22f70c32002-02-18 01:17:00 +0000667** pointer to an array of Column structures, one for each column.
668**
drhd24cc422003-03-27 12:51:24 +0000669** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
670** the column that is that key. Otherwise Table.iPKey is negative. Note
drh22f70c32002-02-18 01:17:00 +0000671** that the datatype of the PRIMARY KEY must be INTEGER for this field to
672** be set. An INTEGER PRIMARY KEY is used as the rowid for each row of
673** the table. If a table has no INTEGER PRIMARY KEY, then a random rowid
drhd24cc422003-03-27 12:51:24 +0000674** is generated for each row of the table. Table.hasPrimKey is true if
drh22f70c32002-02-18 01:17:00 +0000675** the table has any PRIMARY KEY, INTEGER or otherwise.
676**
danielk1977eecfb3e2006-01-10 12:31:39 +0000677** TODO: This comment is out of date. Table.iDb no longer exists.
678**
drhd24cc422003-03-27 12:51:24 +0000679** Table.tnum is the page number for the root BTree page of the table in the
680** database file. If Table.iDb is the index of the database table backend
681** in sqlite.aDb[]. 0 is for the main database and 1 is for the file that
682** holds temporary tables and indices. If Table.isTransient
drh22f70c32002-02-18 01:17:00 +0000683** is true, then the table is stored in a file that is automatically deleted
drhd24cc422003-03-27 12:51:24 +0000684** when the VDBE cursor to the table is closed. In this case Table.tnum
drh22f70c32002-02-18 01:17:00 +0000685** refers VDBE cursor number that holds the table open, not to the root
686** page number. Transient tables are used to hold the results of a
687** sub-query that appears instead of a real table name in the FROM clause
688** of a SELECT statement.
drh75897232000-05-29 14:26:00 +0000689*/
690struct Table {
drh967e8b72000-06-21 13:59:10 +0000691 char *zName; /* Name of the table */
drh967e8b72000-06-21 13:59:10 +0000692 int nCol; /* Number of columns in this table */
693 Column *aCol; /* Information about each column */
drhc8392582001-12-31 02:48:51 +0000694 int iPKey; /* If not less then 0, use aCol[iPKey] as the primary key */
drh967e8b72000-06-21 13:59:10 +0000695 Index *pIndex; /* List of SQL indexes on this table. */
drh22f70c32002-02-18 01:17:00 +0000696 int tnum; /* Root BTree node for this table (see note above) */
drha76b5df2002-02-23 02:32:10 +0000697 Select *pSelect; /* NULL for tables. Points to definition if a view. */
drh717e6402001-09-27 03:22:32 +0000698 u8 readOnly; /* True if this table should not be written by the user */
drh22f70c32002-02-18 01:17:00 +0000699 u8 isTransient; /* True if automatically deleted when VDBE finishes */
drh4a324312001-12-21 14:30:42 +0000700 u8 hasPrimKey; /* True if there exists a primary key */
drh9cfcf5d2002-01-29 18:41:24 +0000701 u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */
drh205f48e2004-11-05 00:43:11 +0000702 u8 autoInc; /* True if the integer primary key is autoincrement */
drhed8a3bb2005-06-06 21:19:56 +0000703 int nRef; /* Number of pointers to this Table */
danielk1977c3f9bad2002-05-15 08:30:12 +0000704 Trigger *pTrigger; /* List of SQL triggers on this table */
drhc2eef3b2002-08-31 18:53:06 +0000705 FKey *pFKey; /* Linked list of all foreign keys in this table */
danielk19773d1bfea2004-05-14 11:00:53 +0000706 char *zColAff; /* String defining the affinity of each column */
drhffe07b22005-11-03 00:41:17 +0000707#ifndef SQLITE_OMIT_CHECK
708 Expr *pCheck; /* The AND of all CHECK constraints */
709#endif
danielk197719a8e7e2005-03-17 05:03:38 +0000710#ifndef SQLITE_OMIT_ALTERTABLE
711 int addColOffset; /* Offset in CREATE TABLE statement to add a new column */
712#endif
danielk1977e501b892006-01-09 06:29:47 +0000713 Schema *pSchema;
drh75897232000-05-29 14:26:00 +0000714};
715
716/*
drhc2eef3b2002-08-31 18:53:06 +0000717** Each foreign key constraint is an instance of the following structure.
718**
719** A foreign key is associated with two tables. The "from" table is
720** the table that contains the REFERENCES clause that creates the foreign
721** key. The "to" table is the table that is named in the REFERENCES clause.
722** Consider this example:
723**
724** CREATE TABLE ex1(
725** a INTEGER PRIMARY KEY,
726** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
727** );
728**
729** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
730**
731** Each REFERENCES clause generates an instance of the following structure
732** which is attached to the from-table. The to-table need not exist when
733** the from-table is created. The existance of the to-table is not checked
734** until an attempt is made to insert data into the from-table.
735**
drhea1ba172003-04-20 00:00:23 +0000736** The sqlite.aFKey hash table stores pointers to this structure
drhc2eef3b2002-08-31 18:53:06 +0000737** given the name of a to-table. For each to-table, all foreign keys
738** associated with that table are on a linked list using the FKey.pNextTo
739** field.
740*/
741struct FKey {
742 Table *pFrom; /* The table that constains the REFERENCES clause */
743 FKey *pNextFrom; /* Next foreign key in pFrom */
744 char *zTo; /* Name of table that the key points to */
745 FKey *pNextTo; /* Next foreign key that points to zTo */
746 int nCol; /* Number of columns in this key */
747 struct sColMap { /* Mapping of columns in pFrom to columns in zTo */
748 int iFrom; /* Index of column in pFrom */
749 char *zCol; /* Name of column in zTo. If 0 use PRIMARY KEY */
750 } *aCol; /* One entry for each of nCol column s */
751 u8 isDeferred; /* True if constraint checking is deferred till COMMIT */
752 u8 updateConf; /* How to resolve conflicts that occur on UPDATE */
753 u8 deleteConf; /* How to resolve conflicts that occur on DELETE */
754 u8 insertConf; /* How to resolve conflicts that occur on INSERT */
755};
756
757/*
758** SQLite supports many different ways to resolve a contraint
drh22f70c32002-02-18 01:17:00 +0000759** error. ROLLBACK processing means that a constraint violation
drh0bd1f4e2002-06-06 18:54:39 +0000760** causes the operation in process to fail and for the current transaction
drh1c928532002-01-31 15:54:21 +0000761** to be rolled back. ABORT processing means the operation in process
762** fails and any prior changes from that one operation are backed out,
763** but the transaction is not rolled back. FAIL processing means that
764** the operation in progress stops and returns an error code. But prior
765** changes due to the same operation are not backed out and no rollback
766** occurs. IGNORE means that the particular row that caused the constraint
767** error is not inserted or updated. Processing continues and no error
768** is returned. REPLACE means that preexisting database rows that caused
769** a UNIQUE constraint violation are removed so that the new insert or
770** update can proceed. Processing continues and no error is reported.
drhc2eef3b2002-08-31 18:53:06 +0000771**
772** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
773** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
774** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign
775** key is set to NULL. CASCADE means that a DELETE or UPDATE of the
776** referenced table row is propagated into the row that holds the
777** foreign key.
drh1c928532002-01-31 15:54:21 +0000778**
drh968af522003-02-11 14:55:40 +0000779** The following symbolic values are used to record which type
drh1c928532002-01-31 15:54:21 +0000780** of action to take.
drh9cfcf5d2002-01-29 18:41:24 +0000781*/
drh1c928532002-01-31 15:54:21 +0000782#define OE_None 0 /* There is no constraint to check */
783#define OE_Rollback 1 /* Fail the operation and rollback the transaction */
784#define OE_Abort 2 /* Back out changes but do no rollback transaction */
785#define OE_Fail 3 /* Stop the operation but leave all prior changes */
786#define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */
787#define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */
drhc2eef3b2002-08-31 18:53:06 +0000788
789#define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
790#define OE_SetNull 7 /* Set the foreign key value to NULL */
791#define OE_SetDflt 8 /* Set the foreign key value to its default */
792#define OE_Cascade 9 /* Cascade the changes */
793
794#define OE_Default 99 /* Do whatever the default action is */
drh9cfcf5d2002-01-29 18:41:24 +0000795
drhd3d39e92004-05-20 22:16:29 +0000796
797/*
798** An instance of the following structure is passed as the first
799** argument to sqlite3VdbeKeyCompare and is used to control the
800** comparison of the two index keys.
801**
802** If the KeyInfo.incrKey value is true and the comparison would
drh7e627792005-04-29 02:10:00 +0000803** otherwise be equal, then return a result as if the second key
804** were larger.
drhd3d39e92004-05-20 22:16:29 +0000805*/
806struct KeyInfo {
danielk1977b1bc9532004-05-22 03:05:33 +0000807 u8 enc; /* Text encoding - one of the TEXT_Utf* values */
drhd3d39e92004-05-20 22:16:29 +0000808 u8 incrKey; /* Increase 2nd key by epsilon before comparison */
809 int nField; /* Number of entries in aColl[] */
danielk1977eecfb3e2006-01-10 12:31:39 +0000810 u8 *aSortOrder; /* If defined and aSortOrder[i] is true, sort DESC */
drhd3d39e92004-05-20 22:16:29 +0000811 CollSeq *aColl[1]; /* Collating sequence for each term of the key */
812};
813
drh9cfcf5d2002-01-29 18:41:24 +0000814/*
drh66b89c82000-11-28 20:47:17 +0000815** Each SQL index is represented in memory by an
drh75897232000-05-29 14:26:00 +0000816** instance of the following structure.
drh967e8b72000-06-21 13:59:10 +0000817**
818** The columns of the table that are to be indexed are described
819** by the aiColumn[] field of this structure. For example, suppose
820** we have the following table and index:
821**
822** CREATE TABLE Ex1(c1 int, c2 int, c3 text);
823** CREATE INDEX Ex2 ON Ex1(c3,c1);
824**
825** In the Table structure describing Ex1, nCol==3 because there are
826** three columns in the table. In the Index structure describing
827** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
828** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the
829** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
830** The second column to be indexed (c1) has an index of 0 in
831** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
drhea1ba172003-04-20 00:00:23 +0000832**
833** The Index.onError field determines whether or not the indexed columns
834** must be unique and what to do if they are not. When Index.onError=OE_None,
835** it means this is not a unique index. Otherwise it is a unique index
836** and the value of Index.onError indicate the which conflict resolution
837** algorithm to employ whenever an attempt is made to insert a non-unique
838** element.
drh75897232000-05-29 14:26:00 +0000839*/
840struct Index {
drh967e8b72000-06-21 13:59:10 +0000841 char *zName; /* Name of this index */
drh967e8b72000-06-21 13:59:10 +0000842 int nColumn; /* Number of columns in the table used by this index */
843 int *aiColumn; /* Which columns are used by this index. 1st is 0 */
drh8b3d9902005-08-19 00:14:42 +0000844 unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
drh967e8b72000-06-21 13:59:10 +0000845 Table *pTable; /* The SQL table being indexed */
drhbe0072d2001-09-13 14:46:09 +0000846 int tnum; /* Page containing root of this index in database file */
drh9cfcf5d2002-01-29 18:41:24 +0000847 u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
drh485b39b2002-07-13 03:11:52 +0000848 u8 autoIndex; /* True if is automatically created (ex: by UNIQUE) */
danielk1977a37cdde2004-05-16 11:15:36 +0000849 char *zColAff; /* String defining the affinity of each column */
drh967e8b72000-06-21 13:59:10 +0000850 Index *pNext; /* The next index associated with the same table */
danielk1977eecfb3e2006-01-10 12:31:39 +0000851 Schema *pSchema; /* Schema containing this index */
drhd3d39e92004-05-20 22:16:29 +0000852 KeyInfo keyInfo; /* Info on how to order keys. MUST BE LAST */
drh75897232000-05-29 14:26:00 +0000853};
854
855/*
856** Each token coming out of the lexer is an instance of
drh4b59ab52002-08-24 18:24:51 +0000857** this structure. Tokens are also used as part of an expression.
drh4efc4752004-01-16 15:55:37 +0000858**
859** Note if Token.z==0 then Token.dyn and Token.n are undefined and
860** may contain random values. Do not make any assuptions about Token.dyn
861** and Token.n when Token.z==0.
drh75897232000-05-29 14:26:00 +0000862*/
863struct Token {
drh4c755c02004-08-08 20:22:17 +0000864 const unsigned char *z; /* Text of the token. Not NULL-terminated! */
865 unsigned dyn : 1; /* True for malloced memory, false for static */
866 unsigned n : 31; /* Number of characters in this token */
drh75897232000-05-29 14:26:00 +0000867};
868
869/*
drh13449892005-09-07 21:22:45 +0000870** An instance of this structure contains information needed to generate
871** code for a SELECT that contains aggregate functions.
872**
873** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
874** pointer to this structure. The Expr.iColumn field is the index in
875** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
876** code for that node.
877**
878** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
879** original Select structure that describes the SELECT statement. These
880** fields do not need to be freed when deallocating the AggInfo structure.
881*/
882struct AggInfo {
883 u8 directMode; /* Direct rendering mode means take data directly
884 ** from source tables rather than from accumulators */
885 u8 useSortingIdx; /* In direct mode, reference the sorting index rather
886 ** than the source table */
887 int sortingIdx; /* Cursor number of the sorting index */
888 ExprList *pGroupBy; /* The group by clause */
889 int nSortingColumn; /* Number of columns in the sorting index */
890 struct AggInfo_col { /* For each column used in source tables */
891 int iTable; /* Cursor number of the source table */
892 int iColumn; /* Column number within the source table */
893 int iSorterColumn; /* Column number in the sorting index */
894 int iMem; /* Memory location that acts as accumulator */
drh5774b802005-09-07 22:48:16 +0000895 Expr *pExpr; /* The original expression */
drh13449892005-09-07 21:22:45 +0000896 } *aCol;
897 int nColumn; /* Number of used entries in aCol[] */
898 int nColumnAlloc; /* Number of slots allocated for aCol[] */
899 int nAccumulator; /* Number of columns that show through to the output.
900 ** Additional columns are used only as parameters to
901 ** aggregate functions */
902 struct AggInfo_func { /* For each aggregate function */
903 Expr *pExpr; /* Expression encoding the function */
904 FuncDef *pFunc; /* The aggregate function implementation */
905 int iMem; /* Memory location that acts as accumulator */
drhfd357972005-09-09 01:33:19 +0000906 int iDistinct; /* Virtual table used to enforce DISTINCT */
drh13449892005-09-07 21:22:45 +0000907 } *aFunc;
908 int nFunc; /* Number of entries in aFunc[] */
909 int nFuncAlloc; /* Number of slots allocated for aFunc[] */
910};
911
912/*
drh75897232000-05-29 14:26:00 +0000913** Each node of an expression in the parse tree is an instance
drh22f70c32002-02-18 01:17:00 +0000914** of this structure.
915**
916** Expr.op is the opcode. The integer parser token codes are reused
917** as opcodes here. For example, the parser defines TK_GE to be an integer
918** code representing the ">=" operator. This same integer code is reused
919** to represent the greater-than-or-equal-to operator in the expression
920** tree.
921**
922** Expr.pRight and Expr.pLeft are subexpressions. Expr.pList is a list
923** of argument if the expression is a function.
924**
drh4b59ab52002-08-24 18:24:51 +0000925** Expr.token is the operator token for this node. For some expressions
926** that have subexpressions, Expr.token can be the complete text that gave
927** rise to the Expr. In the latter case, the token is marked as being
928** a compound token.
drh22f70c32002-02-18 01:17:00 +0000929**
930** An expression of the form ID or ID.ID refers to a column in a table.
931** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
932** the integer cursor number of a VDBE cursor pointing to that table and
933** Expr.iColumn is the column number for the specific column. If the
934** expression is used as a result in an aggregate SELECT, then the
935** value is also stored in the Expr.iAgg column in the aggregate so that
936** it can be accessed after all aggregates are computed.
937**
938** If the expression is a function, the Expr.iTable is an integer code
drh7c972de2003-09-06 22:18:07 +0000939** representing which function. If the expression is an unbound variable
940** marker (a question mark character '?' in the original SQL) then the
941** Expr.iTable holds the index number for that variable.
drh22f70c32002-02-18 01:17:00 +0000942**
drh1398ad32005-01-19 23:24:50 +0000943** If the expression is a subquery then Expr.iColumn holds an integer
944** register number containing the result of the subquery. If the
945** subquery gives a constant result, then iTable is -1. If the subquery
946** gives a different answer at different times during statement processing
947** then iTable is the address of a subroutine that computes the subquery.
948**
drh22f70c32002-02-18 01:17:00 +0000949** The Expr.pSelect field points to a SELECT statement. The SELECT might
950** be the right operand of an IN operator. Or, if a scalar SELECT appears
951** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
952** operand.
danielk1977aee18ef2005-03-09 12:26:50 +0000953**
954** If the Expr is of type OP_Column, and the table it is selecting from
955** is a disk table or the "old.*" pseudo-table, then pTab points to the
956** corresponding table definition.
drh75897232000-05-29 14:26:00 +0000957*/
958struct Expr {
drh1cc093c2002-06-24 22:01:57 +0000959 u8 op; /* Operation performed by this node */
drha9fd84b2004-05-18 23:21:35 +0000960 char affinity; /* The affinity of the column or 0 if not a column */
drhe22a3342003-04-22 20:30:37 +0000961 u8 flags; /* Various flags. See below */
drhf2bc0132004-10-04 13:19:23 +0000962 CollSeq *pColl; /* The collation type of the column or 0 */
drh75897232000-05-29 14:26:00 +0000963 Expr *pLeft, *pRight; /* Left and right subnodes */
drhd99f7062002-06-08 23:25:08 +0000964 ExprList *pList; /* A list of expressions used as function arguments
965 ** or in "<expr> IN (<expr-list)" */
drh75897232000-05-29 14:26:00 +0000966 Token token; /* An operand token */
drh6977fea2002-10-22 23:38:04 +0000967 Token span; /* Complete text of the expression */
drh967e8b72000-06-21 13:59:10 +0000968 int iTable, iColumn; /* When op==TK_COLUMN, then this expr node means the
drh8e2ca022002-06-17 17:07:19 +0000969 ** iColumn-th field of the iTable-th table. */
drh13449892005-09-07 21:22:45 +0000970 AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
971 int iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
drh22d6a532005-09-19 21:05:48 +0000972 int iRightJoinTable; /* If EP_FromJoin, the right table of the join */
drhd99f7062002-06-08 23:25:08 +0000973 Select *pSelect; /* When the expression is a sub-select. Also the
974 ** right side of "<expr> IN (<select>)" */
danielk1977aee18ef2005-03-09 12:26:50 +0000975 Table *pTab; /* Table for OP_Column expressions. */
danielk1977e501b892006-01-09 06:29:47 +0000976 Schema *pSchema;
drh75897232000-05-29 14:26:00 +0000977};
978
979/*
drh1f162302002-10-27 19:35:33 +0000980** The following are the meanings of bits in the Expr.flags field.
981*/
drh392e5972005-07-08 14:14:22 +0000982#define EP_FromJoin 0x01 /* Originated in ON or USING clause of a join */
983#define EP_Agg 0x02 /* Contains one or more aggregate functions */
984#define EP_Resolved 0x04 /* IDs have been resolved to COLUMNs */
985#define EP_Error 0x08 /* Expression contains one or more errors */
drhfd357972005-09-09 01:33:19 +0000986#define EP_Distinct 0x10 /* Aggregate function with DISTINCT keyword */
drh392e5972005-07-08 14:14:22 +0000987#define EP_VarSelect 0x20 /* pSelect is correlated, not constant */
drhd2687b72005-08-12 22:56:09 +0000988#define EP_Dequoted 0x40 /* True if the string has been dequoted */
drh1f162302002-10-27 19:35:33 +0000989
990/*
991** These macros can be used to test, set, or clear bits in the
992** Expr.flags field.
993*/
994#define ExprHasProperty(E,P) (((E)->flags&(P))==(P))
995#define ExprHasAnyProperty(E,P) (((E)->flags&(P))!=0)
996#define ExprSetProperty(E,P) (E)->flags|=(P)
997#define ExprClearProperty(E,P) (E)->flags&=~(P)
998
999/*
drh75897232000-05-29 14:26:00 +00001000** A list of expressions. Each expression may optionally have a
1001** name. An expr/name combination can be used in several ways, such
1002** as the list of "expr AS ID" fields following a "SELECT" or in the
1003** list of "ID = expr" items in an UPDATE. A list of expressions can
drhad3cab52002-05-24 02:04:32 +00001004** also be used as the argument to a function, in which case the a.zName
drh75897232000-05-29 14:26:00 +00001005** field is not used.
1006*/
1007struct ExprList {
1008 int nExpr; /* Number of expressions on the list */
drh4305d102003-07-30 12:34:12 +00001009 int nAlloc; /* Number of entries allocated below */
drh9d2985c2005-09-08 01:58:42 +00001010 int iECursor; /* VDBE Cursor associated with this ExprList */
drh6d4abfb2001-10-22 02:58:08 +00001011 struct ExprList_item {
drh75897232000-05-29 14:26:00 +00001012 Expr *pExpr; /* The list of expressions */
1013 char *zName; /* Token associated with this expression */
drh8e2ca022002-06-17 17:07:19 +00001014 u8 sortOrder; /* 1 for DESC or 0 for ASC */
1015 u8 isAgg; /* True if this is an aggregate like count(*) */
1016 u8 done; /* A flag to indicate when processing is finished */
drh75897232000-05-29 14:26:00 +00001017 } *a; /* One entry for each expression */
1018};
1019
1020/*
drhad3cab52002-05-24 02:04:32 +00001021** An instance of this structure can hold a simple list of identifiers,
1022** such as the list "a,b,c" in the following statements:
1023**
1024** INSERT INTO t(a,b,c) VALUES ...;
1025** CREATE INDEX idx ON t(a,b,c);
1026** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1027**
1028** The IdList.a.idx field is used when the IdList represents the list of
1029** column names after a table name in an INSERT statement. In the statement
1030**
1031** INSERT INTO t(a,b,c) ...
1032**
1033** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
drh75897232000-05-29 14:26:00 +00001034*/
1035struct IdList {
drh6d4abfb2001-10-22 02:58:08 +00001036 struct IdList_item {
drhad3cab52002-05-24 02:04:32 +00001037 char *zName; /* Name of the identifier */
drh967e8b72000-06-21 13:59:10 +00001038 int idx; /* Index in some Table.aCol[] of a column named zName */
drhad3cab52002-05-24 02:04:32 +00001039 } *a;
drh13449892005-09-07 21:22:45 +00001040 int nId; /* Number of identifiers on the list */
1041 int nAlloc; /* Number of entries allocated for a[] below */
drhad3cab52002-05-24 02:04:32 +00001042};
1043
1044/*
drh51669862004-12-18 18:40:26 +00001045** The bitmask datatype defined below is used for various optimizations.
1046*/
1047typedef unsigned int Bitmask;
1048
1049/*
drhad3cab52002-05-24 02:04:32 +00001050** The following structure describes the FROM clause of a SELECT statement.
1051** Each table or subquery in the FROM clause is a separate element of
1052** the SrcList.a[] array.
drhd24cc422003-03-27 12:51:24 +00001053**
1054** With the addition of multiple database support, the following structure
1055** can also be used to describe a particular table such as the table that
1056** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL,
1057** such a table must be a simple name: ID. But in SQLite, the table can
1058** now be identified by a database name, a dot, then the table name: ID.ID.
drhad3cab52002-05-24 02:04:32 +00001059*/
1060struct SrcList {
drh939a16d2004-07-15 13:37:22 +00001061 i16 nSrc; /* Number of tables or subqueries in the FROM clause */
1062 i16 nAlloc; /* Number of entries allocated in a[] below */
drhad3cab52002-05-24 02:04:32 +00001063 struct SrcList_item {
drh113088e2003-03-20 01:16:58 +00001064 char *zDatabase; /* Name of database holding this table */
drhad3cab52002-05-24 02:04:32 +00001065 char *zName; /* Name of the table */
1066 char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */
drhdaffd0e2001-04-11 14:28:42 +00001067 Table *pTab; /* An SQL table corresponding to zName */
1068 Select *pSelect; /* A SELECT statement used in place of a table name */
drhfe05af82005-07-21 03:14:59 +00001069 u8 jointype; /* Type of join between this table and the next */
1070 i16 iCursor; /* The VDBE cursor number used to access this table */
drhad3cab52002-05-24 02:04:32 +00001071 Expr *pOn; /* The ON clause of a join */
1072 IdList *pUsing; /* The USING clause of a join */
drh51669862004-12-18 18:40:26 +00001073 Bitmask colUsed; /* Bit N (1<<N) set if column N or pTab is used */
drh113088e2003-03-20 01:16:58 +00001074 } a[1]; /* One entry for each identifier on the list */
drh75897232000-05-29 14:26:00 +00001075};
1076
1077/*
drh01f3f252002-05-24 16:14:15 +00001078** Permitted values of the SrcList.a.jointype field
1079*/
1080#define JT_INNER 0x0001 /* Any kind of inner or cross join */
drh3dec2232005-09-10 15:28:09 +00001081#define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */
1082#define JT_NATURAL 0x0004 /* True for a "natural" join */
1083#define JT_LEFT 0x0008 /* Left outer join */
1084#define JT_RIGHT 0x0010 /* Right outer join */
1085#define JT_OUTER 0x0020 /* The "OUTER" keyword is present */
1086#define JT_ERROR 0x0040 /* unknown or unsupported join type */
drh01f3f252002-05-24 16:14:15 +00001087
1088/*
drh6b563442001-11-07 16:48:26 +00001089** For each nested loop in a WHERE clause implementation, the WhereInfo
1090** structure contains a single instance of this structure. This structure
1091** is intended to be private the the where.c module and should not be
1092** access or modified by other modules.
1093*/
1094struct WhereLevel {
drh29dda4a2005-07-21 18:23:20 +00001095 int iFrom; /* Which entry in the FROM clause */
1096 int flags; /* Flags associated with this level */
drh51147ba2005-07-23 22:59:55 +00001097 int iMem; /* First memory cell used by this level */
drh29dda4a2005-07-21 18:23:20 +00001098 int iLeftJoin; /* Memory cell used to implement LEFT OUTER JOIN */
1099 Index *pIdx; /* Index used. NULL if no index */
1100 int iTabCur; /* The VDBE cursor used to access the table */
1101 int iIdxCur; /* The VDBE cursor used to acesss pIdx */
1102 int brk; /* Jump here to break out of the loop */
1103 int cont; /* Jump here to continue with the next loop cycle */
1104 int top; /* First instruction of interior of the loop */
1105 int op, p1, p2; /* Opcode used to terminate the loop */
drh51147ba2005-07-23 22:59:55 +00001106 int nEq; /* Number of == or IN constraints on this loop */
drhe23399f2005-07-22 00:31:39 +00001107 int nIn; /* Number of IN operators constraining this loop */
1108 int *aInLoop; /* Loop terminators for IN operators */
drh6b563442001-11-07 16:48:26 +00001109};
1110
1111/*
drh75897232000-05-29 14:26:00 +00001112** The WHERE clause processing routine has two halves. The
1113** first part does the start of the WHERE loop and the second
1114** half does the tail of the WHERE loop. An instance of
1115** this structure is returned by the first half and passed
1116** into the second half to give some continuity.
1117*/
1118struct WhereInfo {
1119 Parse *pParse;
drhad3cab52002-05-24 02:04:32 +00001120 SrcList *pTabList; /* List of tables in the join */
drh9012bcb2004-12-19 00:11:35 +00001121 int iTop; /* The very beginning of the WHERE loop */
drh19a775c2000-06-05 18:54:46 +00001122 int iContinue; /* Jump here to continue with next record */
1123 int iBreak; /* Jump here to break out of the loop */
drh6b563442001-11-07 16:48:26 +00001124 int nLevel; /* Number of nested loop */
1125 WhereLevel a[1]; /* Information about each nest loop in the WHERE */
drh75897232000-05-29 14:26:00 +00001126};
1127
1128/*
danielk1977b3bce662005-01-29 08:32:43 +00001129** A NameContext defines a context in which to resolve table and column
1130** names. The context consists of a list of tables (the pSrcList) field and
1131** a list of named expression (pEList). The named expression list may
1132** be NULL. The pSrc corresponds to the FROM clause of a SELECT or
1133** to the table being operated on by INSERT, UPDATE, or DELETE. The
1134** pEList corresponds to the result set of a SELECT and is NULL for
1135** other statements.
1136**
1137** NameContexts can be nested. When resolving names, the inner-most
1138** context is searched first. If no match is found, the next outer
1139** context is checked. If there is still no match, the next context
1140** is checked. This process continues until either a match is found
1141** or all contexts are check. When a match is found, the nRef member of
1142** the context containing the match is incremented.
1143**
1144** Each subquery gets a new NameContext. The pNext field points to the
1145** NameContext in the parent query. Thus the process of scanning the
1146** NameContext list corresponds to searching through successively outer
1147** subqueries looking for a match.
1148*/
1149struct NameContext {
1150 Parse *pParse; /* The parser */
1151 SrcList *pSrcList; /* One or more tables used to resolve names */
1152 ExprList *pEList; /* Optional list of named expressions */
1153 int nRef; /* Number of names resolved by this context */
1154 int nErr; /* Number of errors encountered while resolving names */
1155 u8 allowAgg; /* Aggregate functions allowed here */
drh13449892005-09-07 21:22:45 +00001156 u8 hasAgg; /* True if aggregates are seen */
drh06f65412005-11-03 02:03:13 +00001157 u8 isCheck; /* True if resolving names in a CHECK constraint */
danielk1977b3bce662005-01-29 08:32:43 +00001158 int nDepth; /* Depth of subquery recursion. 1 for no recursion */
drh13449892005-09-07 21:22:45 +00001159 AggInfo *pAggInfo; /* Information about aggregates at this level */
danielk1977b3bce662005-01-29 08:32:43 +00001160 NameContext *pNext; /* Next outer name context. NULL for outermost */
1161};
1162
1163/*
drh9bb61fe2000-06-05 16:01:39 +00001164** An instance of the following structure contains all information
1165** needed to generate code for a single SELECT statement.
drha76b5df2002-02-23 02:32:10 +00001166**
drhd11d3822002-06-21 23:01:49 +00001167** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0.
1168** If there is a LIMIT clause, the parser sets nLimit to the value of the
1169** limit and nOffset to the value of the offset (or 0 if there is not
1170** offset). But later on, nLimit and nOffset become the memory locations
1171** in the VDBE that record the limit and offset counters.
drh0342b1f2005-09-01 03:07:44 +00001172**
1173** addrOpenVirt[] entries contain the address of OP_OpenVirtual opcodes.
1174** These addresses must be stored so that we can go back and fill in
1175** the P3_KEYINFO and P2 parameters later. Neither the KeyInfo nor
1176** the number of columns in P2 can be computed at the same time
1177** as the OP_OpenVirtual instruction is coded because not
1178** enough information about the compound query is known at that point.
1179** The KeyInfo for addrOpenVirt[0] and [1] contains collating sequences
1180** for the result set. The KeyInfo for addrOpenVirt[2] contains collating
1181** sequences for the ORDER BY clause.
drh9bb61fe2000-06-05 16:01:39 +00001182*/
1183struct Select {
drh9bb61fe2000-06-05 16:01:39 +00001184 ExprList *pEList; /* The fields of the result */
drh7b58dae2003-07-20 01:16:46 +00001185 u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
1186 u8 isDistinct; /* True if the DISTINCT keyword is present */
drh0342b1f2005-09-01 03:07:44 +00001187 u8 isResolved; /* True once sqlite3SelectResolve() has run. */
1188 u8 isAgg; /* True if this is an aggregate query */
1189 u8 usesVirt; /* True if uses an OpenVirtual opcode */
drh4b14b4d2005-09-19 17:35:53 +00001190 u8 disallowOrderBy; /* Do not allow an ORDER BY to be attached if TRUE */
drhad3cab52002-05-24 02:04:32 +00001191 SrcList *pSrc; /* The FROM clause */
drh9bb61fe2000-06-05 16:01:39 +00001192 Expr *pWhere; /* The WHERE clause */
1193 ExprList *pGroupBy; /* The GROUP BY clause */
1194 Expr *pHaving; /* The HAVING clause */
1195 ExprList *pOrderBy; /* The ORDER BY clause */
drh967e8b72000-06-21 13:59:10 +00001196 Select *pPrior; /* Prior select in a compound select statement */
drh0342b1f2005-09-01 03:07:44 +00001197 Select *pRightmost; /* Right-most select in a compound select statement */
danielk1977a2dc3b12005-02-05 12:48:48 +00001198 Expr *pLimit; /* LIMIT expression. NULL means not used. */
1199 Expr *pOffset; /* OFFSET expression. NULL means not used. */
drh7b58dae2003-07-20 01:16:46 +00001200 int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */
drh0342b1f2005-09-01 03:07:44 +00001201 int addrOpenVirt[3]; /* OP_OpenVirtual opcodes related to this select */
drh9bb61fe2000-06-05 16:01:39 +00001202};
1203
1204/*
drhfef52082000-06-06 01:50:43 +00001205** The results of a select can be distributed in several ways.
1206*/
drh13449892005-09-07 21:22:45 +00001207#define SRT_Union 1 /* Store result as keys in an index */
1208#define SRT_Except 2 /* Remove result from a UNION index */
1209#define SRT_Discard 3 /* Do not save the results anywhere */
drhfef52082000-06-06 01:50:43 +00001210
drh13449892005-09-07 21:22:45 +00001211/* The ORDER BY clause is ignored for all of the above */
1212#define IgnorableOrderby(X) (X<=SRT_Discard)
1213
1214#define SRT_Callback 4 /* Invoke a callback with each row of result */
1215#define SRT_Mem 5 /* Store result in a memory cell */
1216#define SRT_Set 6 /* Store non-null results as keys in an index */
drhd49c16e2005-09-08 02:00:25 +00001217#define SRT_Table 7 /* Store result as data with an automatic rowid */
1218#define SRT_VirtualTab 8 /* Create virtual table and store like SRT_Table */
drh9d2985c2005-09-08 01:58:42 +00001219#define SRT_Subroutine 9 /* Call a subroutine to handle results */
drhec7429a2005-10-06 16:53:14 +00001220#define SRT_Exists 10 /* Store 1 if the result is not empty */
drh22827922000-06-06 17:27:05 +00001221
1222/*
drhf57b3392001-10-08 13:22:32 +00001223** An SQL parser context. A copy of this structure is passed through
1224** the parser and down into all the parser action routine in order to
1225** carry around information that is global to the entire parse.
drhf1974842004-11-05 03:56:00 +00001226**
1227** The structure is divided into two parts. When the parser and code
1228** generate call themselves recursively, the first part of the structure
1229** is constant but the second part is reset at the beginning and end of
1230** each recursion.
danielk1977c00da102006-01-07 13:21:04 +00001231**
1232** The nTableLock and aTableLock variables are only used if the shared-cache
1233** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
1234** used to store the set of table-locks required by the statement being
1235** compiled. Function sqlite3TableLock() is used to add entries to the
1236** list.
drh75897232000-05-29 14:26:00 +00001237*/
1238struct Parse {
drh9bb575f2004-09-06 17:24:11 +00001239 sqlite3 *db; /* The main database structure */
drh4c504392000-10-16 22:06:40 +00001240 int rc; /* Return code from execution */
drh75897232000-05-29 14:26:00 +00001241 char *zErrMsg; /* An error message */
drh75897232000-05-29 14:26:00 +00001242 Vdbe *pVdbe; /* An engine for executing database bytecode */
drh836faa42003-01-11 13:30:57 +00001243 u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */
drhe0bc4042002-06-25 01:09:11 +00001244 u8 nameClash; /* A permanent table name clashes with temp table name */
drha6ecd332004-06-10 00:29:09 +00001245 u8 checkSchema; /* Causes schema cookie check after an error */
drh205f48e2004-11-05 00:43:11 +00001246 u8 nested; /* Number of nested calls to the parser/code generator */
drh75897232000-05-29 14:26:00 +00001247 int nErr; /* Number of errors seen */
drh832508b2002-03-02 17:04:07 +00001248 int nTab; /* Number of previously allocated VDBE cursors */
drh19a775c2000-06-05 18:54:46 +00001249 int nMem; /* Number of memory cells used so far */
drhfef52082000-06-06 01:50:43 +00001250 int nSet; /* Number of sets used so far */
drhffe07b22005-11-03 00:41:17 +00001251 int ckOffset; /* Stack offset to data used by CHECK constraints */
drh80242052004-06-09 00:48:12 +00001252 u32 writeMask; /* Start a write transaction on these databases */
drhfcd35c72005-05-21 02:48:08 +00001253 u32 cookieMask; /* Bitmask of schema verified databases */
1254 int cookieGoto; /* Address of OP_Goto to cookie verifier subroutine */
1255 int cookieValue[MAX_ATTACHED+2]; /* Values of cookies to verify */
danielk1977c00da102006-01-07 13:21:04 +00001256#ifndef SQLITE_OMIT_SHARED_CACHE
1257 int nTableLock; /* Number of locks in aTableLock */
1258 TableLock *aTableLock; /* Required table locks for shared-cache mode */
1259#endif
drhf1974842004-11-05 03:56:00 +00001260
1261 /* Above is constant between recursions. Below is reset before and after
1262 ** each recursion */
1263
1264 int nVar; /* Number of '?' variables seen in the SQL so far */
1265 int nVarExpr; /* Number of used slots in apVarExpr[] */
1266 int nVarExprAlloc; /* Number of allocated slots in apVarExpr[] */
1267 Expr **apVarExpr; /* Pointers to :aaa and $aaaa wildcard expressions */
1268 u8 explain; /* True if the EXPLAIN flag is found on the query */
drhf1974842004-11-05 03:56:00 +00001269 Token sErrToken; /* The token at which the error occurred */
1270 Token sNameToken; /* Token with unqualified schema object name */
1271 Token sLastToken; /* The last token parsed */
1272 const char *zSql; /* All SQL text */
1273 const char *zTail; /* All SQL text past the last semicolon parsed */
1274 Table *pNewTable; /* A table being constructed by CREATE TABLE */
1275 Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */
1276 TriggerStack *trigStack; /* Trigger actions being coded */
1277 const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
drh75897232000-05-29 14:26:00 +00001278};
1279
danielk1977d99bc932002-05-16 00:13:12 +00001280/*
drh85e20962003-04-25 17:52:11 +00001281** An instance of the following structure can be declared on a stack and used
1282** to save the Parse.zAuthContext value so that it can be restored later.
1283*/
1284struct AuthContext {
1285 const char *zAuthContext; /* Put saved Parse.zAuthContext here */
1286 Parse *pParse; /* The Parse structure */
1287};
1288
1289/*
drhf0863fe2005-06-12 21:35:51 +00001290** Bitfield flags for P2 value in OP_Insert and OP_Delete
rdcb0c374f2004-02-20 22:53:38 +00001291*/
1292#define OPFLAG_NCHANGE 1 /* Set to update db->nChange */
1293#define OPFLAG_LASTROWID 2 /* Set to update db->lastRowid */
danielk197794eb6a12005-12-15 15:22:08 +00001294#define OPFLAG_ISUPDATE 4 /* This OP_Insert is an sql UPDATE */
rdcb0c374f2004-02-20 22:53:38 +00001295
1296/*
danielk1977d99bc932002-05-16 00:13:12 +00001297 * Each trigger present in the database schema is stored as an instance of
1298 * struct Trigger.
1299 *
1300 * Pointers to instances of struct Trigger are stored in two ways.
drh9bb575f2004-09-06 17:24:11 +00001301 * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
danielk1977d99bc932002-05-16 00:13:12 +00001302 * database). This allows Trigger structures to be retrieved by name.
1303 * 2. All triggers associated with a single table form a linked list, using the
drhad3cab52002-05-24 02:04:32 +00001304 * pNext member of struct Trigger. A pointer to the first element of the
1305 * linked list is stored as the "pTrigger" member of the associated
1306 * struct Table.
danielk1977d99bc932002-05-16 00:13:12 +00001307 *
drhad3cab52002-05-24 02:04:32 +00001308 * The "step_list" member points to the first element of a linked list
1309 * containing the SQL statements specified as the trigger program.
danielk1977d99bc932002-05-16 00:13:12 +00001310 */
danielk1977c3f9bad2002-05-15 08:30:12 +00001311struct Trigger {
drhdc379452002-05-15 12:45:43 +00001312 char *name; /* The name of the trigger */
1313 char *table; /* The table or view to which the trigger applies */
drhf0f258b2003-04-21 18:48:45 +00001314 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */
drhdca76842004-12-07 14:06:13 +00001315 u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
drhdc379452002-05-15 12:45:43 +00001316 Expr *pWhen; /* The WHEN clause of the expresion (may be NULL) */
1317 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger,
danielk1977d99bc932002-05-16 00:13:12 +00001318 the <column-list> is stored here */
drhdc379452002-05-15 12:45:43 +00001319 int foreach; /* One of TK_ROW or TK_STATEMENT */
drh4312db52003-06-03 01:47:11 +00001320 Token nameToken; /* Token containing zName. Use during parsing only */
danielk1977e501b892006-01-09 06:29:47 +00001321 Schema *pSchema; /* Schema containing the trigger */
1322 Schema *pTabSchema; /* Schema containing the table */
drhdc379452002-05-15 12:45:43 +00001323 TriggerStep *step_list; /* Link list of trigger program steps */
drhdc379452002-05-15 12:45:43 +00001324 Trigger *pNext; /* Next trigger associated with the table */
danielk1977c3f9bad2002-05-15 08:30:12 +00001325};
1326
danielk1977d99bc932002-05-16 00:13:12 +00001327/*
drhdca76842004-12-07 14:06:13 +00001328** A trigger is either a BEFORE or an AFTER trigger. The following constants
1329** determine which.
1330**
1331** If there are multiple triggers, you might of some BEFORE and some AFTER.
1332** In that cases, the constants below can be ORed together.
1333*/
1334#define TRIGGER_BEFORE 1
1335#define TRIGGER_AFTER 2
1336
1337/*
danielk1977d99bc932002-05-16 00:13:12 +00001338 * An instance of struct TriggerStep is used to store a single SQL statement
1339 * that is a part of a trigger-program.
1340 *
1341 * Instances of struct TriggerStep are stored in a singly linked list (linked
1342 * using the "pNext" member) referenced by the "step_list" member of the
1343 * associated struct Trigger instance. The first element of the linked list is
1344 * the first step of the trigger-program.
1345 *
1346 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
1347 * "SELECT" statement. The meanings of the other members is determined by the
1348 * value of "op" as follows:
1349 *
1350 * (op == TK_INSERT)
1351 * orconf -> stores the ON CONFLICT algorithm
1352 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then
1353 * this stores a pointer to the SELECT statement. Otherwise NULL.
1354 * target -> A token holding the name of the table to insert into.
1355 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
1356 * this stores values to be inserted. Otherwise NULL.
1357 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ...
drhad3cab52002-05-24 02:04:32 +00001358 * statement, then this stores the column-names to be
1359 * inserted into.
danielk1977d99bc932002-05-16 00:13:12 +00001360 *
1361 * (op == TK_DELETE)
1362 * target -> A token holding the name of the table to delete from.
1363 * pWhere -> The WHERE clause of the DELETE statement if one is specified.
1364 * Otherwise NULL.
1365 *
1366 * (op == TK_UPDATE)
1367 * target -> A token holding the name of the table to update rows of.
1368 * pWhere -> The WHERE clause of the UPDATE statement if one is specified.
1369 * Otherwise NULL.
1370 * pExprList -> A list of the columns to update and the expressions to update
danielk19774adee202004-05-08 08:23:19 +00001371 * them to. See sqlite3Update() documentation of "pChanges"
drhad3cab52002-05-24 02:04:32 +00001372 * argument.
danielk1977d99bc932002-05-16 00:13:12 +00001373 *
1374 */
1375struct TriggerStep {
1376 int op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1377 int orconf; /* OE_Rollback etc. */
drha69d9162003-04-17 22:57:53 +00001378 Trigger *pTrig; /* The trigger that this step is a part of */
danielk1977c3f9bad2002-05-15 08:30:12 +00001379
danielk1977d99bc932002-05-16 00:13:12 +00001380 Select *pSelect; /* Valid for SELECT and sometimes
1381 INSERT steps (when pExprList == 0) */
1382 Token target; /* Valid for DELETE, UPDATE, INSERT steps */
1383 Expr *pWhere; /* Valid for DELETE, UPDATE steps */
1384 ExprList *pExprList; /* Valid for UPDATE statements and sometimes
1385 INSERT steps (when pSelect == 0) */
1386 IdList *pIdList; /* Valid for INSERT statements only */
1387
1388 TriggerStep * pNext; /* Next in the link-list */
1389};
1390
1391/*
1392 * An instance of struct TriggerStack stores information required during code
1393 * generation of a single trigger program. While the trigger program is being
1394 * coded, its associated TriggerStack instance is pointed to by the
1395 * "pTriggerStack" member of the Parse structure.
1396 *
1397 * The pTab member points to the table that triggers are being coded on. The
1398 * newIdx member contains the index of the vdbe cursor that points at the temp
1399 * table that stores the new.* references. If new.* references are not valid
1400 * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1401 * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1402 *
1403 * The ON CONFLICT policy to be used for the trigger program steps is stored
1404 * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1405 * specified for individual triggers steps is used.
1406 *
1407 * struct TriggerStack has a "pNext" member, to allow linked lists to be
1408 * constructed. When coding nested triggers (triggers fired by other triggers)
1409 * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1410 * pointer. Once the nested trigger has been coded, the pNext value is restored
1411 * to the pTriggerStack member of the Parse stucture and coding of the parent
1412 * trigger continues.
1413 *
1414 * Before a nested trigger is coded, the linked list pointed to by the
1415 * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1416 * recursively. If this condition is detected, the nested trigger is not coded.
1417 */
1418struct TriggerStack {
1419 Table *pTab; /* Table that triggers are currently being coded on */
1420 int newIdx; /* Index of vdbe cursor to "new" temp table */
1421 int oldIdx; /* Index of vdbe cursor to "old" temp table */
1422 int orconf; /* Current orconf policy */
danielk19776f349032002-06-11 02:25:40 +00001423 int ignoreJump; /* where to jump to for a RAISE(IGNORE) */
drhe22a3342003-04-22 20:30:37 +00001424 Trigger *pTrigger; /* The trigger currently being coded */
1425 TriggerStack *pNext; /* Next trigger down on the trigger stack */
danielk1977d99bc932002-05-16 00:13:12 +00001426};
1427
1428/*
drhf26e09c2003-05-31 16:21:12 +00001429** The following structure contains information used by the sqliteFix...
1430** routines as they walk the parse tree to make database references
1431** explicit.
1432*/
1433typedef struct DbFixer DbFixer;
1434struct DbFixer {
1435 Parse *pParse; /* The parsing context. Error messages written here */
1436 const char *zDb; /* Make sure all objects are contained in this database */
1437 const char *zType; /* Type of the container - used for error messages */
1438 const Token *pName; /* Name of the container - used for error messages */
1439};
1440
1441/*
drh234c39d2004-07-24 03:30:47 +00001442** A pointer to this structure is used to communicate information
1443** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
1444*/
1445typedef struct {
drh9bb575f2004-09-06 17:24:11 +00001446 sqlite3 *db; /* The database being initialized */
drh234c39d2004-07-24 03:30:47 +00001447 char **pzErrMsg; /* Error message stored here */
1448} InitData;
1449
drhb6c29892004-11-22 19:12:19 +00001450/*
danielk1977d99bc932002-05-16 00:13:12 +00001451 * This global flag is set for performance testing of triggers. When it is set
1452 * SQLite will perform the overhead of building new and old trigger references
1453 * even when no triggers exist
1454 */
drh38f82712004-06-18 17:10:16 +00001455extern int sqlite3_always_code_trigger_setup;
danielk1977c3f9bad2002-05-15 08:30:12 +00001456
drh75897232000-05-29 14:26:00 +00001457/*
drh49285702005-09-17 15:20:26 +00001458** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production
1459** builds) or a function call (for debugging). If it is a function call,
1460** it allows the operator to set a breakpoint at the spot where database
1461** corruption is first detected.
1462*/
1463#ifdef SQLITE_DEBUG
1464 extern int sqlite3Corrupt(void);
1465# define SQLITE_CORRUPT_BKPT sqlite3Corrupt()
1466#else
1467# define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT
1468#endif
1469
1470/*
drh75897232000-05-29 14:26:00 +00001471** Internal function prototypes
1472*/
danielk19774adee202004-05-08 08:23:19 +00001473int sqlite3StrICmp(const char *, const char *);
1474int sqlite3StrNICmp(const char *, const char *, int);
1475int sqlite3HashNoCase(const char *, int);
danielk19778a6b5412004-05-24 07:04:25 +00001476int sqlite3IsNumber(const char*, int*, u8);
danielk19774adee202004-05-08 08:23:19 +00001477int sqlite3Compare(const char *, const char *);
1478int sqlite3SortCompare(const char *, const char *);
1479void sqlite3RealToSortable(double r, char *);
danielk19772e588c72005-12-09 14:25:08 +00001480
1481void *sqlite3Malloc(int);
1482void *sqlite3MallocRaw(int);
1483void sqlite3Free(void*);
1484void *sqlite3Realloc(void*,int);
1485char *sqlite3StrDup(const char*);
1486char *sqlite3StrNDup(const char*, int);
danielk19774adee202004-05-08 08:23:19 +00001487# define sqlite3CheckMemory(a,b)
drh53f733c2005-09-16 02:38:09 +00001488void sqlite3ReallocOrFree(void**,int);
drh998da3a2004-06-19 15:22:56 +00001489void sqlite3FreeX(void*);
drh132d8d62005-05-22 20:12:37 +00001490void *sqlite3MallocX(int);
danielk197713f72992005-12-18 08:51:22 +00001491int sqlite3AllocSize(void *);
danielk19772e588c72005-12-09 14:25:08 +00001492
danielk19774adee202004-05-08 08:23:19 +00001493char *sqlite3MPrintf(const char*, ...);
1494char *sqlite3VMPrintf(const char*, va_list);
drhe54ca3f2004-06-07 01:52:14 +00001495void sqlite3DebugPrintf(const char*, ...);
drhfe63d1c2004-09-08 20:13:04 +00001496void *sqlite3TextToPtr(const char*);
drh41f58522005-06-06 15:06:39 +00001497void sqlite3SetString(char **, ...);
danielk19774adee202004-05-08 08:23:19 +00001498void sqlite3ErrorMsg(Parse*, const char*, ...);
drha0733842005-12-29 01:11:36 +00001499void sqlite3ErrorClear(Parse*);
danielk19774adee202004-05-08 08:23:19 +00001500void sqlite3Dequote(char*);
drhd2687b72005-08-12 22:56:09 +00001501void sqlite3DequoteExpr(Expr*);
drh2646da72005-12-09 20:02:05 +00001502int sqlite3KeywordCode(const unsigned char*, int);
danielk19774adee202004-05-08 08:23:19 +00001503int sqlite3RunParser(Parse*, const char*, char **);
drh80242052004-06-09 00:48:12 +00001504void sqlite3FinishCoding(Parse*);
drhe4e72072004-11-23 01:47:30 +00001505Expr *sqlite3Expr(int, Expr*, Expr*, const Token*);
drh4e0cff62004-11-05 05:10:28 +00001506Expr *sqlite3RegisterExpr(Parse*,Token*);
drh91bb0ee2004-09-01 03:06:34 +00001507Expr *sqlite3ExprAnd(Expr*, Expr*);
danielk19774adee202004-05-08 08:23:19 +00001508void sqlite3ExprSpan(Expr*,Token*,Token*);
1509Expr *sqlite3ExprFunction(ExprList*, Token*);
drhfa6bc002004-09-07 16:19:52 +00001510void sqlite3ExprAssignVarNumber(Parse*, Expr*);
danielk19774adee202004-05-08 08:23:19 +00001511void sqlite3ExprDelete(Expr*);
1512ExprList *sqlite3ExprListAppend(ExprList*,Expr*,Token*);
1513void sqlite3ExprListDelete(ExprList*);
drh9bb575f2004-09-06 17:24:11 +00001514int sqlite3Init(sqlite3*, char**);
drh234c39d2004-07-24 03:30:47 +00001515int sqlite3InitCallback(void*, int, char**, char**);
danielk197791cf71b2004-06-26 06:37:06 +00001516void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
drh9bb575f2004-09-06 17:24:11 +00001517void sqlite3ResetInternalSchema(sqlite3*, int);
danielk19774adee202004-05-08 08:23:19 +00001518void sqlite3BeginParse(Parse*,int);
drh9bb575f2004-09-06 17:24:11 +00001519void sqlite3RollbackInternalChanges(sqlite3*);
1520void sqlite3CommitInternalChanges(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00001521Table *sqlite3ResultSetOfSelect(Parse*,char*,Select*);
danielk1977c00da102006-01-07 13:21:04 +00001522void sqlite3OpenMasterTable(Parse *, int);
drhfaa59552005-12-29 23:33:54 +00001523void sqlite3StartTable(Parse*,Token*,Token*,Token*,int,int,int);
danielk19774adee202004-05-08 08:23:19 +00001524void sqlite3AddColumn(Parse*,Token*);
1525void sqlite3AddNotNull(Parse*, int);
drhfdd6e852005-12-16 01:06:16 +00001526void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
drhffe07b22005-11-03 00:41:17 +00001527void sqlite3AddCheckConstraint(Parse*, Expr*);
drh487e2622005-06-25 18:42:14 +00001528void sqlite3AddColumnType(Parse*,Token*);
danielk19777977a172004-11-09 12:44:37 +00001529void sqlite3AddDefaultValue(Parse*,Expr*);
drhd3d39e92004-05-20 22:16:29 +00001530void sqlite3AddCollateType(Parse*, const char*, int);
danielk197719a8e7e2005-03-17 05:03:38 +00001531void sqlite3EndTable(Parse*,Token*,Token*,Select*);
drhb7f91642004-10-31 02:22:47 +00001532
1533#ifndef SQLITE_OMIT_VIEW
1534 void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int);
1535 int sqlite3ViewGetColumnNames(Parse*,Table*);
1536#else
1537# define sqlite3ViewGetColumnNames(A,B) 0
1538#endif
1539
drha0733842005-12-29 01:11:36 +00001540void sqlite3DropTable(Parse*, SrcList*, int, int);
drh9bb575f2004-09-06 17:24:11 +00001541void sqlite3DeleteTable(sqlite3*, Table*);
danielk19774adee202004-05-08 08:23:19 +00001542void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
drh13449892005-09-07 21:22:45 +00001543int sqlite3ArrayAllocate(void**,int,int);
danielk19774adee202004-05-08 08:23:19 +00001544IdList *sqlite3IdListAppend(IdList*, Token*);
1545int sqlite3IdListIndex(IdList*,const char*);
1546SrcList *sqlite3SrcListAppend(SrcList*, Token*, Token*);
1547void sqlite3SrcListAddAlias(SrcList*, Token*);
1548void sqlite3SrcListAssignCursors(Parse*, SrcList*);
1549void sqlite3IdListDelete(IdList*);
1550void sqlite3SrcListDelete(SrcList*);
danielk19770202b292004-06-09 09:55:16 +00001551void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
drh4d91a702006-01-04 15:54:36 +00001552 Token*, int, int);
1553void sqlite3DropIndex(Parse*, SrcList*, int);
danielk19774adee202004-05-08 08:23:19 +00001554void sqlite3AddKeyType(Vdbe*, ExprList*);
1555void sqlite3AddIdxKeyType(Vdbe*, Index*);
danielk1977b3bce662005-01-29 08:32:43 +00001556int sqlite3Select(Parse*, Select*, int, int, Select*, int, int*, char *aff);
danielk19774adee202004-05-08 08:23:19 +00001557Select *sqlite3SelectNew(ExprList*,SrcList*,Expr*,ExprList*,Expr*,ExprList*,
danielk1977a2dc3b12005-02-05 12:48:48 +00001558 int,Expr*,Expr*);
danielk19774adee202004-05-08 08:23:19 +00001559void sqlite3SelectDelete(Select*);
1560void sqlite3SelectUnbind(Select*);
1561Table *sqlite3SrcListLookup(Parse*, SrcList*);
1562int sqlite3IsReadOnly(Parse*, Table*, int);
danielk1977c00da102006-01-07 13:21:04 +00001563void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
danielk19774adee202004-05-08 08:23:19 +00001564void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
1565void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
drhf8db1bc2005-04-22 02:38:37 +00001566WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**);
danielk19774adee202004-05-08 08:23:19 +00001567void sqlite3WhereEnd(WhereInfo*);
1568void sqlite3ExprCode(Parse*, Expr*);
drh25303782004-12-07 15:41:48 +00001569void sqlite3ExprCodeAndCache(Parse*, Expr*);
drhf9b596e2004-05-26 16:54:42 +00001570int sqlite3ExprCodeExprList(Parse*, ExprList*);
danielk19774adee202004-05-08 08:23:19 +00001571void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
1572void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
drh205f48e2004-11-05 00:43:11 +00001573void sqlite3NextedParse(Parse*, const char*, ...);
drh9bb575f2004-09-06 17:24:11 +00001574Table *sqlite3FindTable(sqlite3*,const char*, const char*);
danielk19774adee202004-05-08 08:23:19 +00001575Table *sqlite3LocateTable(Parse*,const char*, const char*);
drh9bb575f2004-09-06 17:24:11 +00001576Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
1577void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
1578void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
danielk19774adee202004-05-08 08:23:19 +00001579void sqlite3Vacuum(Parse*, Token*);
drh9bb575f2004-09-06 17:24:11 +00001580int sqlite3RunVacuum(char**, sqlite3*);
drha99db3b2004-06-19 14:49:12 +00001581char *sqlite3NameFromToken(Token*);
danielk19774adee202004-05-08 08:23:19 +00001582int sqlite3ExprCheck(Parse*, Expr*, int, int*);
danielk19774adee202004-05-08 08:23:19 +00001583int sqlite3ExprCompare(Expr*, Expr*);
drhcce7d172000-05-31 15:34:51 +00001584int sqliteFuncId(Token*);
danielk1977b3bce662005-01-29 08:32:43 +00001585int sqlite3ExprResolveNames(NameContext *, Expr *);
danielk1977a58fdfb2005-02-08 07:50:40 +00001586int sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
drh5d9a4af2005-08-30 00:54:01 +00001587int sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
danielk19774adee202004-05-08 08:23:19 +00001588Vdbe *sqlite3GetVdbe(Parse*);
1589void sqlite3Randomness(int, void*);
drh9bb575f2004-09-06 17:24:11 +00001590void sqlite3RollbackAll(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00001591void sqlite3CodeVerifySchema(Parse*, int);
drh684917c2004-10-05 02:41:42 +00001592void sqlite3BeginTransaction(Parse*, int);
danielk19774adee202004-05-08 08:23:19 +00001593void sqlite3CommitTransaction(Parse*);
1594void sqlite3RollbackTransaction(Parse*);
1595int sqlite3ExprIsConstant(Expr*);
drheb55bd22005-06-30 17:04:21 +00001596int sqlite3ExprIsConstantOrFunction(Expr*);
danielk19774adee202004-05-08 08:23:19 +00001597int sqlite3ExprIsInteger(Expr*, int*);
1598int sqlite3IsRowid(const char*);
drh9bb575f2004-09-06 17:24:11 +00001599void sqlite3GenerateRowDelete(sqlite3*, Vdbe*, Table*, int, int);
1600void sqlite3GenerateRowIndexDelete(sqlite3*, Vdbe*, Table*, int, char*);
drh51846b52004-05-28 16:00:21 +00001601void sqlite3GenerateIndexKey(Vdbe*, Index*, int);
danielk19774adee202004-05-08 08:23:19 +00001602void sqlite3GenerateConstraintChecks(Parse*,Table*,int,char*,int,int,int,int);
1603void sqlite3CompleteInsertion(Parse*, Table*, int, char*, int, int, int);
drh290c1942004-08-21 17:54:45 +00001604void sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
danielk19774adee202004-05-08 08:23:19 +00001605void sqlite3BeginWriteOperation(Parse*, int, int);
danielk19774adee202004-05-08 08:23:19 +00001606Expr *sqlite3ExprDup(Expr*);
1607void sqlite3TokenCopy(Token*, Token*);
1608ExprList *sqlite3ExprListDup(ExprList*);
1609SrcList *sqlite3SrcListDup(SrcList*);
1610IdList *sqlite3IdListDup(IdList*);
1611Select *sqlite3SelectDup(Select*);
drh9bb575f2004-09-06 17:24:11 +00001612FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
1613void sqlite3RegisterBuiltinFunctions(sqlite3*);
1614void sqlite3RegisterDateTimeFunctions(sqlite3*);
1615int sqlite3SafetyOn(sqlite3*);
1616int sqlite3SafetyOff(sqlite3*);
1617int sqlite3SafetyCheck(sqlite3*);
1618void sqlite3ChangeCookie(sqlite3*, Vdbe*, int);
drhb7f91642004-10-31 02:22:47 +00001619
1620#ifndef SQLITE_OMIT_TRIGGER
1621 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
1622 int,Expr*,int);
1623 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
1624 void sqlite3DropTrigger(Parse*, SrcList*);
1625 void sqlite3DropTriggerPtr(Parse*, Trigger*, int);
drhdca76842004-12-07 14:06:13 +00001626 int sqlite3TriggersExist(Parse*, Table*, int, ExprList*);
drhb7f91642004-10-31 02:22:47 +00001627 int sqlite3CodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
1628 int, int);
1629 void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
1630 void sqlite3DeleteTriggerStep(TriggerStep*);
1631 TriggerStep *sqlite3TriggerSelectStep(Select*);
1632 TriggerStep *sqlite3TriggerInsertStep(Token*, IdList*, ExprList*,Select*,int);
1633 TriggerStep *sqlite3TriggerUpdateStep(Token*, ExprList*, Expr*, int);
1634 TriggerStep *sqlite3TriggerDeleteStep(Token*, Expr*);
1635 void sqlite3DeleteTrigger(Trigger*);
1636 void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
1637#else
1638# define sqlite3TriggersExist(A,B,C,D,E,F) 0
1639# define sqlite3DeleteTrigger(A)
1640# define sqlite3DropTriggerPtr(A,B,C)
1641# define sqlite3UnlinkAndDeleteTrigger(A,B,C)
1642# define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I) 0
1643#endif
1644
danielk19774adee202004-05-08 08:23:19 +00001645int sqlite3JoinType(Parse*, Token*, Token*, Token*);
danielk19770202b292004-06-09 09:55:16 +00001646void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
danielk19774adee202004-05-08 08:23:19 +00001647void sqlite3DeferForeignKey(Parse*, int);
drhed6c8672003-01-12 18:02:16 +00001648#ifndef SQLITE_OMIT_AUTHORIZATION
danielk19774adee202004-05-08 08:23:19 +00001649 void sqlite3AuthRead(Parse*,Expr*,SrcList*);
1650 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
1651 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
1652 void sqlite3AuthContextPop(AuthContext*);
drhed6c8672003-01-12 18:02:16 +00001653#else
danielk19774adee202004-05-08 08:23:19 +00001654# define sqlite3AuthRead(a,b,c)
1655# define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK
1656# define sqlite3AuthContextPush(a,b,c)
1657# define sqlite3AuthContextPop(a) ((void)(a))
drhed6c8672003-01-12 18:02:16 +00001658#endif
danielk1977f744bb52005-12-06 17:19:11 +00001659void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
1660void sqlite3Detach(Parse*, Expr*);
drh9bb575f2004-09-06 17:24:11 +00001661int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
drh90f5ecb2004-07-22 01:19:35 +00001662 int omitJournal, int nCache, Btree **ppBtree);
danielk19774adee202004-05-08 08:23:19 +00001663int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
1664int sqlite3FixSrcList(DbFixer*, SrcList*);
1665int sqlite3FixSelect(DbFixer*, Select*);
1666int sqlite3FixExpr(DbFixer*, Expr*);
1667int sqlite3FixExprList(DbFixer*, ExprList*);
1668int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
drh487e2622005-06-25 18:42:14 +00001669int sqlite3AtoF(const char *z, double*);
danielk19776f8a5032004-05-10 10:34:51 +00001670char *sqlite3_snprintf(int,char*,const char*,...);
drhfec19aa2004-05-19 20:41:03 +00001671int sqlite3GetInt32(const char *, int*);
drhfec19aa2004-05-19 20:41:03 +00001672int sqlite3FitsIn64Bits(const char *);
danielk19776622cce2004-05-20 11:00:52 +00001673int sqlite3utf16ByteLen(const void *pData, int nChar);
1674int sqlite3utf8CharLen(const char *pData, int nByte);
drh4e5ffc52004-08-31 00:52:37 +00001675int sqlite3ReadUtf8(const unsigned char *);
danielk1977192ac1d2004-05-10 07:17:30 +00001676int sqlite3PutVarint(unsigned char *, u64);
danielk197790e4d952004-05-10 10:05:53 +00001677int sqlite3GetVarint(const unsigned char *, u64 *);
drh6d2fb152004-05-14 16:50:06 +00001678int sqlite3GetVarint32(const unsigned char *, u32 *);
danielk1977192ac1d2004-05-10 07:17:30 +00001679int sqlite3VarintLen(u64 v);
danielk1977a37cdde2004-05-16 11:15:36 +00001680void sqlite3IndexAffinityStr(Vdbe *, Index *);
1681void sqlite3TableAffinityStr(Vdbe *, Table *);
danielk1977e014a832004-05-17 10:48:57 +00001682char sqlite3CompareAffinity(Expr *pExpr, char aff2);
danielk1977e014a832004-05-17 10:48:57 +00001683int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
danielk1977bf3b7212004-05-18 10:06:24 +00001684char sqlite3ExprAffinity(Expr *pExpr);
drheb2e1762004-05-27 01:53:56 +00001685int sqlite3atoi64(const char*, i64*);
drh9bb575f2004-09-06 17:24:11 +00001686void sqlite3Error(sqlite3*, int, const char*,...);
danielk1977cbb18d22004-05-28 11:37:27 +00001687void *sqlite3HexToBlob(const char *z);
danielk1977ef2cb632004-05-29 02:37:19 +00001688int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
danielk1977f20b21c2004-05-31 23:56:42 +00001689const char *sqlite3ErrStr(int);
danielk1977d02eb1f2004-06-06 09:44:03 +00001690int sqlite3ReadUniChar(const char *zStr, int *pOffset, u8 *pEnc, int fold);
danielk19778a414492004-06-29 08:59:35 +00001691int sqlite3ReadSchema(Parse *pParse);
drh9bb575f2004-09-06 17:24:11 +00001692CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
danielk19770202b292004-06-09 09:55:16 +00001693CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
danielk19777cedc8d2004-06-10 10:50:08 +00001694CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
1695int sqlite3CheckCollSeq(Parse *, CollSeq *);
1696int sqlite3CheckIndexCollSeq(Parse *, Index *);
danielk1977d8123362004-06-12 09:25:12 +00001697int sqlite3CheckObjectName(Parse *, const char *);
danielk1977b28af712004-06-21 06:50:26 +00001698void sqlite3VdbeSetChanges(sqlite3 *, int);
danielk1977f4618892004-06-28 13:09:11 +00001699void sqlite3utf16Substr(sqlite3_context *,int,sqlite3_value **);
danielk19774e6af132004-06-10 14:01:08 +00001700
1701const void *sqlite3ValueText(sqlite3_value*, u8);
1702int sqlite3ValueBytes(sqlite3_value*, u8);
danielk1977bfd6cce2004-06-18 04:24:54 +00001703void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8, void(*)(void*));
danielk19774e6af132004-06-10 14:01:08 +00001704void sqlite3ValueFree(sqlite3_value*);
drh4f26bb62005-09-08 14:17:20 +00001705sqlite3_value *sqlite3ValueNew(void);
drhaf9a7c22005-12-15 03:04:10 +00001706char *sqlite3utf16to8(const void*, int);
danielk1977aee18ef2005-03-09 12:26:50 +00001707int sqlite3ValueFromExpr(Expr *, u8, u8, sqlite3_value **);
1708void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
drh4e5ffc52004-08-31 00:52:37 +00001709extern const unsigned char sqlite3UpperToLower[];
danielk1977a0bf2652004-11-04 14:30:04 +00001710void sqlite3RootPageMoved(Db*, int, int);
drh4343fea2004-11-05 23:46:15 +00001711void sqlite3Reindex(Parse*, Token*, Token*);
drh1f01ec12005-02-15 21:36:18 +00001712void sqlite3AlterFunctions(sqlite3*);
danielk19779fd2a9a2004-11-12 13:42:30 +00001713void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
1714int sqlite3GetToken(const unsigned char *, int *);
drh2958a4e2004-11-12 03:56:15 +00001715void sqlite3NestedParse(Parse*, const char*, ...);
drhd89bd002005-01-22 03:03:54 +00001716void sqlite3ExpirePreparedStatements(sqlite3*);
danielk1977b3bce662005-01-29 08:32:43 +00001717void sqlite3CodeSubselect(Parse *, Expr *);
1718int sqlite3SelectResolve(Parse *, Select *, NameContext *);
danielk1977aee18ef2005-03-09 12:26:50 +00001719void sqlite3ColumnDefault(Vdbe *, Table *, int);
danielk197719a8e7e2005-03-17 05:03:38 +00001720void sqlite3AlterFinishAddColumn(Parse *, Token *);
1721void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
drh2e66f0b2005-04-28 17:18:48 +00001722const char *sqlite3TestErrorName(int);
danielk19774dade032005-05-25 10:45:10 +00001723CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int);
drh8a512562005-11-14 22:29:05 +00001724char sqlite3AffinityType(const Token*);
drh9f18e8a2005-07-08 12:13:04 +00001725void sqlite3Analyze(Parse*, Token*, Token*);
drha4afb652005-07-09 02:16:02 +00001726int sqlite3InvokeBusyHandler(BusyHandler*);
drhff2d5ea2005-07-23 00:41:48 +00001727int sqlite3FindDb(sqlite3*, Token*);
drh497e4462005-07-23 03:18:40 +00001728void sqlite3AnalysisLoad(sqlite3*,int iDB);
drh51147ba2005-07-23 22:59:55 +00001729void sqlite3DefaultRowEst(Index*);
drh55ef4d92005-08-14 01:20:37 +00001730void sqlite3RegisterLikeFunctions(sqlite3*, int);
drhd64fe2f2005-08-28 17:00:23 +00001731int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
danielk1977e501b892006-01-09 06:29:47 +00001732ThreadData *sqlite3ThreadData();
danielk1977f744bb52005-12-06 17:19:11 +00001733void sqlite3AttachFunctions(sqlite3 *);
drhfdd6e852005-12-16 01:06:16 +00001734void sqlite3MinimumFileFormat(Parse*, int, int);
danielk1977da184232006-01-05 11:34:32 +00001735void sqlite3SchemaFree(void *);
danielk1977e501b892006-01-09 06:29:47 +00001736Schema *sqlite3SchemaGet(Btree *);
1737int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
danielk1977e3026632004-06-22 11:29:02 +00001738
danielk1977c00da102006-01-07 13:21:04 +00001739#ifndef SQLITE_OMIT_SHARED_CACHE
1740 void sqlite3TableLock(Parse *, int, int, u8, const char *);
1741#else
1742 #define sqlite3TableLock(v,w,x,y,z)
1743#endif
1744
danielk19772e588c72005-12-09 14:25:08 +00001745void sqlite3MallocClearFailed();
1746#ifdef NDEBUG
1747 #define sqlite3MallocDisallow()
1748 #define sqlite3MallocAllow()
1749#else
1750 void sqlite3MallocDisallow();
1751 void sqlite3MallocAllow();
1752#endif
1753
danielk1977fd9a0a42005-05-24 12:01:00 +00001754#ifdef SQLITE_SSE
1755#include "sseInt.h"
1756#endif
1757
danielk1977e3026632004-06-22 11:29:02 +00001758#endif