blob: 82e3470dc2685305c2fa068b4a651236d8b1ae98 [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**
drh67080612007-10-01 14:30:14 +000014** @(#) $Id: sqliteInt.h,v 1.611 2007/10/01 14:30:15 drh Exp $
drh75897232000-05-29 14:26:00 +000015*/
danielk1977e3026632004-06-22 11:29:02 +000016#ifndef _SQLITEINT_H_
17#define _SQLITEINT_H_
drhc551dd82007-06-19 15:23:48 +000018#include "sqliteLimit.h"
drhc797d4d2007-05-08 01:08:49 +000019
drh33f4e022007-09-03 15:19:34 +000020/*
21** For testing purposes, the various size limit constants are really
22** variables that we can modify in the testfixture.
23*/
danielk1977e6a58a42007-08-31 17:42:48 +000024#ifdef SQLITE_TEST
25 #undef SQLITE_MAX_LENGTH
26 #undef SQLITE_MAX_COLUMN
27 #undef SQLITE_MAX_SQL_LENGTH
28 #undef SQLITE_MAX_EXPR_DEPTH
29 #undef SQLITE_MAX_COMPOUND_SELECT
30 #undef SQLITE_MAX_VDBE_OP
31 #undef SQLITE_MAX_FUNCTION_ARG
32 #undef SQLITE_MAX_VARIABLE_NUMBER
33 #undef SQLITE_MAX_PAGE_SIZE
34 #undef SQLITE_MAX_PAGE_COUNT
35 #undef SQLITE_MAX_LIKE_PATTERN_LENGTH
36
37 #define SQLITE_MAX_LENGTH sqlite3MAX_LENGTH
38 #define SQLITE_MAX_COLUMN sqlite3MAX_COLUMN
39 #define SQLITE_MAX_SQL_LENGTH sqlite3MAX_SQL_LENGTH
40 #define SQLITE_MAX_EXPR_DEPTH sqlite3MAX_EXPR_DEPTH
41 #define SQLITE_MAX_COMPOUND_SELECT sqlite3MAX_COMPOUND_SELECT
42 #define SQLITE_MAX_VDBE_OP sqlite3MAX_VDBE_OP
43 #define SQLITE_MAX_FUNCTION_ARG sqlite3MAX_FUNCTION_ARG
44 #define SQLITE_MAX_VARIABLE_NUMBER sqlite3MAX_VARIABLE_NUMBER
45 #define SQLITE_MAX_PAGE_SIZE sqlite3MAX_PAGE_SIZE
46 #define SQLITE_MAX_PAGE_COUNT sqlite3MAX_PAGE_COUNT
47 #define SQLITE_MAX_LIKE_PATTERN_LENGTH sqlite3MAX_LIKE_PATTERN_LENGTH
48
49 extern int sqlite3MAX_LENGTH;
50 extern int sqlite3MAX_COLUMN;
51 extern int sqlite3MAX_SQL_LENGTH;
52 extern int sqlite3MAX_EXPR_DEPTH;
53 extern int sqlite3MAX_COMPOUND_SELECT;
54 extern int sqlite3MAX_VDBE_OP;
55 extern int sqlite3MAX_FUNCTION_ARG;
56 extern int sqlite3MAX_VARIABLE_NUMBER;
57 extern int sqlite3MAX_PAGE_SIZE;
58 extern int sqlite3MAX_PAGE_COUNT;
59 extern int sqlite3MAX_LIKE_PATTERN_LENGTH;
60#endif
61
drh67080612007-10-01 14:30:14 +000062/*
63** We need to define _XOPEN_SOURCE as follows in order to enable
64** recursive mutexes on most unix systems. But Mac OS X is different.
65** The _XOPEN_SOURCE define causes problems for Mac OS X we are told,
66** so it is omitted there. See ticket #2673.
67*/
68#ifndef __MACOS__
69# define _XOPEN_SOURCE 500 /* Needed to enable pthread recursive mutexes */
70#endif
danielk1977e3026632004-06-22 11:29:02 +000071
drh4f0c5872007-03-26 22:05:01 +000072#if defined(SQLITE_TCL) || defined(TCLSH)
73# include <tcl.h>
drh824d7c12006-01-06 12:03:19 +000074#endif
75
76/*
drh4b529d92005-09-13 00:00:00 +000077** Many people are failing to set -DNDEBUG=1 when compiling SQLite.
drhb27795c2005-09-13 00:02:16 +000078** Setting NDEBUG makes the code smaller and run faster. So the following
drh4b529d92005-09-13 00:00:00 +000079** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1
80** option is set. Thus NDEBUG becomes an opt-in rather than an opt-out
81** feature.
82*/
danielk1977771151b2006-01-17 13:21:40 +000083#if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
drh4b529d92005-09-13 00:00:00 +000084# define NDEBUG 1
85#endif
86
87/*
drhd677b3d2007-08-20 22:48:41 +000088** The SQLITE_THREADSAFE macro must be defined as either 0 or 1.
89** Older versions of SQLite used an optional THREADSAFE macro.
90** We support that for legacy
91*/
92#if !defined(SQLITE_THREADSAFE)
93#if defined(THREADSAFE)
94# define SQLITE_THREADSAFE THREADSAFE
95#else
drhcab5ed72007-08-22 11:41:18 +000096# define SQLITE_THREADSAFE 1
drhd677b3d2007-08-20 22:48:41 +000097#endif
98#endif
99
100/*
drheb206252004-10-01 02:00:31 +0000101** These #defines should enable >2GB file support on Posix if the
102** underlying operating system supports it. If the OS lacks
103** large file support, or if the OS is windows, these should be no-ops.
104**
105** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
106** on the compiler command line. This is necessary if you are compiling
107** on a recent machine (ex: RedHat 7.2) but you want your code to work
108** on an older machine (ex: RedHat 6.0). If you compile on RedHat 7.2
109** without this option, LFS is enable. But LFS does not exist in the kernel
110** in RedHat 6.0, so the code won't work. Hence, for maximum binary
111** portability you should omit LFS.
112**
113** Similar is true for MacOS. LFS is only supported on MacOS 9 and later.
114*/
115#ifndef SQLITE_DISABLE_LFS
116# define _LARGE_FILE 1
117# ifndef _FILE_OFFSET_BITS
118# define _FILE_OFFSET_BITS 64
119# endif
120# define _LARGEFILE_SOURCE 1
121#endif
122
drh1d482dd2004-05-31 18:23:07 +0000123#include "sqlite3.h"
drhbeae3192001-09-22 18:12:08 +0000124#include "hash.h"
drh75897232000-05-29 14:26:00 +0000125#include "parse.h"
drh75897232000-05-29 14:26:00 +0000126#include <stdio.h>
127#include <stdlib.h>
128#include <string.h>
129#include <assert.h>
drh52370e22005-01-21 21:31:40 +0000130#include <stddef.h>
drh75897232000-05-29 14:26:00 +0000131
drh7cd69272007-06-20 15:29:25 +0000132#define sqlite3_isnan(X) ((X)!=(X))
drh7361cb12007-06-10 22:57:33 +0000133
drh967e8b72000-06-21 13:59:10 +0000134/*
drhb37df7b2005-10-13 02:09:49 +0000135** If compiling for a processor that lacks floating point support,
136** substitute integer for floating-point
137*/
138#ifdef SQLITE_OMIT_FLOATING_POINT
139# define double sqlite_int64
140# define LONGDOUBLE_TYPE sqlite_int64
drhd1167392006-01-23 13:00:35 +0000141# ifndef SQLITE_BIG_DBL
142# define SQLITE_BIG_DBL (0x7fffffffffffffff)
143# endif
drhb37df7b2005-10-13 02:09:49 +0000144# define SQLITE_OMIT_DATETIME_FUNCS 1
145# define SQLITE_OMIT_TRACE 1
drh110daac2007-05-04 11:59:31 +0000146# undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
drhb37df7b2005-10-13 02:09:49 +0000147#endif
drhd1167392006-01-23 13:00:35 +0000148#ifndef SQLITE_BIG_DBL
149# define SQLITE_BIG_DBL (1e99)
150#endif
drhb37df7b2005-10-13 02:09:49 +0000151
152/*
danielk197753c0f742005-03-29 03:10:59 +0000153** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
154** afterward. Having this macro allows us to cause the C compiler
155** to omit code used by TEMP tables without messy #ifndef statements.
156*/
157#ifdef SQLITE_OMIT_TEMPDB
158#define OMIT_TEMPDB 1
159#else
160#define OMIT_TEMPDB 0
161#endif
162
163/*
drh0bd1f4e2002-06-06 18:54:39 +0000164** If the following macro is set to 1, then NULL values are considered
drh0bd1f4e2002-06-06 18:54:39 +0000165** distinct when determining whether or not two entries are the same
166** in a UNIQUE index. This is the way PostgreSQL, Oracle, DB2, MySQL,
167** OCELOT, and Firebird all work. The SQL92 spec explicitly says this
168** is the way things are suppose to work.
169**
170** If the following macro is set to 0, the NULLs are indistinct for
171** a UNIQUE index. In this mode, you can only have a single NULL entry
172** for a column declared UNIQUE. This is the way Informix and SQL Server
173** work.
174*/
175#define NULL_DISTINCT_FOR_UNIQUE 1
176
177/*
drhd946db02005-12-29 19:23:06 +0000178** The "file format" number is an integer that is incremented whenever
179** the VDBE-level file format changes. The following macros define the
180** the default file format for new databases and the maximum file format
181** that the library can read.
182*/
183#define SQLITE_MAX_FILE_FORMAT 4
184#ifndef SQLITE_DEFAULT_FILE_FORMAT
drh76fe8032006-07-11 14:17:51 +0000185# define SQLITE_DEFAULT_FILE_FORMAT 1
drhd946db02005-12-29 19:23:06 +0000186#endif
187
188/*
drh49766d62005-01-08 18:42:28 +0000189** Provide a default value for TEMP_STORE in case it is not specified
190** on the command-line
191*/
192#ifndef TEMP_STORE
193# define TEMP_STORE 1
194#endif
195
196/*
drhf1974842004-11-05 03:56:00 +0000197** GCC does not define the offsetof() macro so we'll have to do it
198** ourselves.
199*/
200#ifndef offsetof
201#define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
202#endif
203
204/*
drh9b8f4472006-04-04 01:54:55 +0000205** Check to see if this machine uses EBCDIC. (Yes, believe it or
206** not, there are still machines out there that use EBCDIC.)
207*/
208#if 'A' == '\301'
209# define SQLITE_EBCDIC 1
210#else
211# define SQLITE_ASCII 1
212#endif
213
214/*
drh5a2c2c22001-11-21 02:21:11 +0000215** Integers of known sizes. These typedefs might change for architectures
216** where the sizes very. Preprocessor macros are available so that the
217** types can be conveniently redefined at compile-type. Like this:
218**
219** cc '-DUINTPTR_TYPE=long long int' ...
drh41a2b482001-01-20 19:52:49 +0000220*/
drh5a2c2c22001-11-21 02:21:11 +0000221#ifndef UINT32_TYPE
222# define UINT32_TYPE unsigned int
223#endif
224#ifndef UINT16_TYPE
225# define UINT16_TYPE unsigned short int
226#endif
drh939a16d2004-07-15 13:37:22 +0000227#ifndef INT16_TYPE
228# define INT16_TYPE short int
229#endif
drh5a2c2c22001-11-21 02:21:11 +0000230#ifndef UINT8_TYPE
231# define UINT8_TYPE unsigned char
232#endif
drh905793e2004-02-21 13:31:09 +0000233#ifndef INT8_TYPE
234# define INT8_TYPE signed char
235#endif
drhefad9992004-06-22 12:13:55 +0000236#ifndef LONGDOUBLE_TYPE
237# define LONGDOUBLE_TYPE long double
238#endif
drhefad9992004-06-22 12:13:55 +0000239typedef sqlite_int64 i64; /* 8-byte signed integer */
drh27436af2006-03-28 23:57:17 +0000240typedef sqlite_uint64 u64; /* 8-byte unsigned integer */
drh5a2c2c22001-11-21 02:21:11 +0000241typedef UINT32_TYPE u32; /* 4-byte unsigned integer */
242typedef UINT16_TYPE u16; /* 2-byte unsigned integer */
drh939a16d2004-07-15 13:37:22 +0000243typedef INT16_TYPE i16; /* 2-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000244typedef UINT8_TYPE u8; /* 1-byte unsigned integer */
drh905793e2004-02-21 13:31:09 +0000245typedef UINT8_TYPE i8; /* 1-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000246
247/*
drhbbd42a62004-05-22 17:41:58 +0000248** Macros to determine whether the machine is big or little endian,
249** evaluated at runtime.
250*/
drh46c99e02007-08-27 23:26:59 +0000251#ifdef SQLITE_AMALGAMATION
252const int sqlite3One;
253#else
drhbbd42a62004-05-22 17:41:58 +0000254extern const int sqlite3one;
drh46c99e02007-08-27 23:26:59 +0000255#endif
drh38def052007-03-31 15:27:59 +0000256#if defined(i386) || defined(__i386__) || defined(_M_IX86)
257# define SQLITE_BIGENDIAN 0
258# define SQLITE_LITTLEENDIAN 1
259# define SQLITE_UTF16NATIVE SQLITE_UTF16LE
260#else
261# define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0)
262# define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
263# define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
264#endif
drhbbd42a62004-05-22 17:41:58 +0000265
266/*
drh90f5ecb2004-07-22 01:19:35 +0000267** An instance of the following structure is used to store the busy-handler
268** callback for a given sqlite handle.
269**
270** The sqlite.busyHandler member of the sqlite struct contains the busy
271** callback for the database handle. Each pager opened via the sqlite
272** handle is passed a pointer to sqlite.busyHandler. The busy-handler
273** callback is currently invoked only from within pager.c.
274*/
275typedef struct BusyHandler BusyHandler;
276struct BusyHandler {
277 int (*xFunc)(void *,int); /* The busy callback */
278 void *pArg; /* First arg to busy callback */
drha4afb652005-07-09 02:16:02 +0000279 int nBusy; /* Incremented with each busy call */
drh90f5ecb2004-07-22 01:19:35 +0000280};
281
282/*
283** Defer sourcing vdbe.h and btree.h until after the "u8" and
284** "BusyHandler typedefs.
drh905793e2004-02-21 13:31:09 +0000285*/
drh3aac2dd2004-04-26 14:10:20 +0000286#include "btree.h"
drh900b31e2007-08-28 02:27:51 +0000287#include "vdbe.h"
danielk197713f72992005-12-18 08:51:22 +0000288#include "pager.h"
drh905793e2004-02-21 13:31:09 +0000289
danielk19772e588c72005-12-09 14:25:08 +0000290
drh6e142f52000-06-08 13:36:40 +0000291/*
drh75897232000-05-29 14:26:00 +0000292** Name of the master database table. The master database table
293** is a special table that holds the names and attributes of all
294** user tables and indices.
295*/
drhe0bc4042002-06-25 01:09:11 +0000296#define MASTER_NAME "sqlite_master"
297#define TEMP_MASTER_NAME "sqlite_temp_master"
drh75897232000-05-29 14:26:00 +0000298
299/*
danielk19778e150812004-05-10 01:17:37 +0000300** The root-page of the master database table.
301*/
302#define MASTER_ROOT 1
303
304/*
drhed6c8672003-01-12 18:02:16 +0000305** The name of the schema table.
306*/
danielk197753c0f742005-03-29 03:10:59 +0000307#define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
drhed6c8672003-01-12 18:02:16 +0000308
309/*
drh75897232000-05-29 14:26:00 +0000310** A convenience macro that returns the number of elements in
311** an array.
312*/
313#define ArraySize(X) (sizeof(X)/sizeof(X[0]))
314
315/*
316** Forward references to structures
317*/
drh13449892005-09-07 21:22:45 +0000318typedef struct AggInfo AggInfo;
drhfe05af82005-07-21 03:14:59 +0000319typedef struct AuthContext AuthContext;
320typedef struct CollSeq CollSeq;
drh7020f652000-06-03 18:06:52 +0000321typedef struct Column Column;
drhfe05af82005-07-21 03:14:59 +0000322typedef struct Db Db;
danielk1977e501b892006-01-09 06:29:47 +0000323typedef struct Schema Schema;
drh75897232000-05-29 14:26:00 +0000324typedef struct Expr Expr;
325typedef struct ExprList ExprList;
drhc2eef3b2002-08-31 18:53:06 +0000326typedef struct FKey FKey;
drhfe05af82005-07-21 03:14:59 +0000327typedef struct FuncDef FuncDef;
328typedef struct IdList IdList;
329typedef struct Index Index;
danielk19778d059842004-05-12 11:24:02 +0000330typedef struct KeyClass KeyClass;
drhd3d39e92004-05-20 22:16:29 +0000331typedef struct KeyInfo KeyInfo;
danielk1977d1ab1ba2006-06-15 04:28:13 +0000332typedef struct Module Module;
drh626a8792005-01-17 22:08:19 +0000333typedef struct NameContext NameContext;
drhfe05af82005-07-21 03:14:59 +0000334typedef struct Parse Parse;
335typedef struct Select Select;
336typedef struct SrcList SrcList;
337typedef struct Table Table;
danielk1977c00da102006-01-07 13:21:04 +0000338typedef struct TableLock TableLock;
drhfe05af82005-07-21 03:14:59 +0000339typedef struct Token Token;
340typedef struct TriggerStack TriggerStack;
341typedef struct TriggerStep TriggerStep;
342typedef struct Trigger Trigger;
drhfe05af82005-07-21 03:14:59 +0000343typedef struct WhereInfo WhereInfo;
344typedef struct WhereLevel WhereLevel;
drhd3d39e92004-05-20 22:16:29 +0000345
danielk19771cc5ed82007-05-16 17:28:43 +0000346#include "os.h"
drhc7ce76a2007-08-30 14:10:30 +0000347#include "mutex.h"
danielk19771cc5ed82007-05-16 17:28:43 +0000348
drh001bbcb2003-03-19 03:14:00 +0000349/*
350** Each database file to be accessed by the system is an instance
351** of the following structure. There are normally two of these structures
352** in the sqlite.aDb[] array. aDb[0] is the main database file and
drha69d9162003-04-17 22:57:53 +0000353** aDb[1] is the database file used to hold temporary tables. Additional
354** databases may be attached.
drh001bbcb2003-03-19 03:14:00 +0000355*/
356struct Db {
357 char *zName; /* Name of this database */
358 Btree *pBt; /* The B*Tree structure for this database file */
danielk1977da184232006-01-05 11:34:32 +0000359 u8 inTrans; /* 0: not writable. 1: Transaction. 2: Checkpoint */
360 u8 safety_level; /* How aggressive at synching data to disk */
danielk1977da184232006-01-05 11:34:32 +0000361 void *pAux; /* Auxiliary data. Usually NULL */
362 void (*xFreeAux)(void*); /* Routine to free pAux */
danielk1977e501b892006-01-09 06:29:47 +0000363 Schema *pSchema; /* Pointer to database schema (possibly shared) */
danielk1977da184232006-01-05 11:34:32 +0000364};
365
366/*
367** An instance of the following structure stores a database schema.
danielk1977a04a34f2007-04-16 15:06:25 +0000368**
369** If there are no virtual tables configured in this schema, the
370** Schema.db variable is set to NULL. After the first virtual table
371** has been added, it is set to point to the database connection
372** used to create the connection. Once a virtual table has been
373** added to the Schema structure and the Schema.db variable populated,
374** only that database connection may use the Schema to prepare
375** statements.
danielk1977da184232006-01-05 11:34:32 +0000376*/
danielk1977e501b892006-01-09 06:29:47 +0000377struct Schema {
drh001bbcb2003-03-19 03:14:00 +0000378 int schema_cookie; /* Database schema version number for this file */
drhd24cc422003-03-27 12:51:24 +0000379 Hash tblHash; /* All tables indexed by name */
380 Hash idxHash; /* All (named) indices indexed by name */
381 Hash trigHash; /* All triggers indexed by name */
382 Hash aFKey; /* Foreign keys indexed by to-table */
drh4794f732004-11-05 17:17:50 +0000383 Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */
danielk1977da184232006-01-05 11:34:32 +0000384 u8 file_format; /* Schema format version for this file */
drh8079a0d2006-01-12 17:20:50 +0000385 u8 enc; /* Text encoding used by this database */
danielk1977da184232006-01-05 11:34:32 +0000386 u16 flags; /* Flags associated with this schema */
danielk197714db2662006-01-09 16:12:04 +0000387 int cache_size; /* Number of pages to use in the cache */
danielk1977a04a34f2007-04-16 15:06:25 +0000388#ifndef SQLITE_OMIT_VIRTUALTABLE
389 sqlite3 *db; /* "Owner" connection. See comment above */
390#endif
drh001bbcb2003-03-19 03:14:00 +0000391};
drh75897232000-05-29 14:26:00 +0000392
393/*
drh8bf8dc92003-05-17 17:35:10 +0000394** These macros can be used to test, set, or clear bits in the
395** Db.flags field.
396*/
danielk1977da184232006-01-05 11:34:32 +0000397#define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))==(P))
398#define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))!=0)
399#define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->flags|=(P)
400#define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->flags&=~(P)
drh8bf8dc92003-05-17 17:35:10 +0000401
402/*
403** Allowed values for the DB.flags field.
404**
drh8bf8dc92003-05-17 17:35:10 +0000405** The DB_SchemaLoaded flag is set after the database schema has been
406** read into internal hash tables.
407**
408** DB_UnresetViews means that one or more views have column names that
409** have been filled out. If the schema changes, these column names might
410** changes and so the view will need to be reset.
411*/
drh124b27e2004-06-19 16:06:10 +0000412#define DB_SchemaLoaded 0x0001 /* The schema has been loaded */
413#define DB_UnresetViews 0x0002 /* Some views have defined column names */
danielk1977b82e7ed2006-01-11 14:09:31 +0000414#define DB_Empty 0x0004 /* The file is empty (length 0 bytes) */
drh8bf8dc92003-05-17 17:35:10 +0000415
416
417/*
drhc9b84a12002-06-20 11:36:48 +0000418** Each database is an instance of the following structure.
419**
rdcb0c374f2004-02-20 22:53:38 +0000420** The sqlite.lastRowid records the last insert rowid generated by an
421** insert statement. Inserts on views do not affect its value. Each
422** trigger has its own context, so that lastRowid can be updated inside
423** triggers as usual. The previous value will be restored once the trigger
424** exits. Upon entering a before or instead of trigger, lastRowid is no
425** longer (since after version 2.8.12) reset to -1.
426**
427** The sqlite.nChange does not count changes within triggers and keeps no
danielk19776f8a5032004-05-10 10:34:51 +0000428** context. It is reset at start of sqlite3_exec.
rdcb0c374f2004-02-20 22:53:38 +0000429** The sqlite.lsChange represents the number of changes made by the last
430** insert, update, or delete statement. It remains constant throughout the
431** length of a statement and is then updated by OP_SetCounts. It keeps a
432** context stack just like lastRowid so that the count of changes
433** within a trigger is not seen outside the trigger. Changes to views do not
434** affect the value of lsChange.
435** The sqlite.csChange keeps track of the number of current changes (since
436** the last statement) and is used to update sqlite_lsChange.
danielk19776622cce2004-05-20 11:00:52 +0000437**
438** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
439** store the most recent error code and, if applicable, string. The
440** internal function sqlite3Error() is used to set these variables
441** consistently.
drh75897232000-05-29 14:26:00 +0000442*/
drh9bb575f2004-09-06 17:24:11 +0000443struct sqlite3 {
drh90f6a5b2007-08-15 13:04:54 +0000444 sqlite3_vfs *pVfs; /* OS Interface */
drh001bbcb2003-03-19 03:14:00 +0000445 int nDb; /* Number of backends currently in use */
446 Db *aDb; /* All backends */
drh5e00f6c2001-09-13 13:46:56 +0000447 int flags; /* Miscellanous flags. See below */
drh33f4e022007-09-03 15:19:34 +0000448 int openFlags; /* Flags passed to sqlite3_vfs.xOpen() */
drhfcd35c72005-05-21 02:48:08 +0000449 int errCode; /* Most recent error code (SQLITE_*) */
drh4ac285a2006-09-15 07:28:50 +0000450 int errMask; /* & result codes with this before returning */
drhfcd35c72005-05-21 02:48:08 +0000451 u8 autoCommit; /* The auto-commit flag. */
drh90f5ecb2004-07-22 01:19:35 +0000452 u8 temp_store; /* 1: file 2: memory 0: default */
drh17435752007-08-16 04:30:38 +0000453 u8 mallocFailed; /* True if we have seen a malloc failure */
drh5e00f6c2001-09-13 13:46:56 +0000454 int nTable; /* Number of tables in the database */
drhd3d39e92004-05-20 22:16:29 +0000455 CollSeq *pDfltColl; /* The default collating sequence (BINARY) */
drhf328bc82004-05-10 23:29:49 +0000456 i64 lastRowid; /* ROWID of most recent insert (see above) */
457 i64 priorNewRowid; /* Last randomly generated ROWID */
drh247be432002-05-10 05:44:55 +0000458 int magic; /* Magic number for detect library misuse */
danielk1977b28af712004-06-21 06:50:26 +0000459 int nChange; /* Value returned by sqlite3_changes() */
460 int nTotalChange; /* Value returned by sqlite3_total_changes() */
drhd677b3d2007-08-20 22:48:41 +0000461 sqlite3_mutex *mutex; /* Connection mutex */
danielk1977b28af712004-06-21 06:50:26 +0000462 struct sqlite3InitInfo { /* Information used during initialization */
463 int iDb; /* When back is being initialized */
464 int newTnum; /* Rootpage of table being initialized */
465 u8 busy; /* TRUE if currently initializing */
drh1d85d932004-02-14 23:05:52 +0000466 } init;
drhf1952c52006-06-08 15:48:00 +0000467 int nExtension; /* Number of loaded extensions */
drh761df872006-12-21 01:29:22 +0000468 void **aExtension; /* Array of shared libraray handles */
drh326dce72003-01-29 14:06:07 +0000469 struct Vdbe *pVdbe; /* List of active virtual machines */
danielk19771d850a72004-05-31 08:26:49 +0000470 int activeVdbeCnt; /* Number of vdbes currently executing */
drh19e2d372005-08-29 23:00:03 +0000471 void (*xTrace)(void*,const char*); /* Trace function */
472 void *pTraceArg; /* Argument to the trace function */
473 void (*xProfile)(void*,const char*,u64); /* Profiling function */
474 void *pProfileArg; /* Argument to profile function */
danielk197771fd80b2005-12-16 06:54:01 +0000475 void *pCommitArg; /* Argument to xCommitCallback() */
476 int (*xCommitCallback)(void*); /* Invoked at every commit. */
477 void *pRollbackArg; /* Argument to xRollbackCallback() */
478 void (*xRollbackCallback)(void*); /* Invoked at every commit. */
danielk197794eb6a12005-12-15 15:22:08 +0000479 void *pUpdateArg;
480 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
drhfcd35c72005-05-21 02:48:08 +0000481 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
482 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
483 void *pCollNeededArg;
drhfcd35c72005-05-21 02:48:08 +0000484 sqlite3_value *pErr; /* Most recent error message */
485 char *zErrMsg; /* Most recent error message (UTF-8 encoded) */
486 char *zErrMsg16; /* Most recent error message (UTF-16 encoded) */
drh881feaa2006-07-26 01:39:30 +0000487 union {
488 int isInterrupted; /* True if sqlite3_interrupt has been called */
489 double notUsed1; /* Spacer */
490 } u1;
drhed6c8672003-01-12 18:02:16 +0000491#ifndef SQLITE_OMIT_AUTHORIZATION
drhe22a3342003-04-22 20:30:37 +0000492 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
493 /* Access authorization function */
drhed6c8672003-01-12 18:02:16 +0000494 void *pAuthArg; /* 1st argument to the access auth function */
495#endif
danielk1977348bb5d2003-10-18 09:37:26 +0000496#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
497 int (*xProgress)(void *); /* The progress callback */
498 void *pProgressArg; /* Argument to the progress callback */
499 int nProgressOps; /* Number of opcodes for progress callback */
500#endif
drhb9bb7c12006-06-11 23:41:55 +0000501#ifndef SQLITE_OMIT_VIRTUALTABLE
502 Hash aModule; /* populated by sqlite3_create_module() */
danielk19777e6ebfb2006-06-12 11:24:37 +0000503 Table *pVTab; /* vtab with active Connect/Create method */
danielk1977f9e7dda2006-06-16 16:08:53 +0000504 sqlite3_vtab **aVTrans; /* Virtual tables with open transactions */
505 int nVTrans; /* Allocated size of aVTrans */
danielk19776b456a22005-03-21 04:04:02 +0000506#endif
drhfcd35c72005-05-21 02:48:08 +0000507 Hash aFunc; /* All functions that can be in SQL exprs */
508 Hash aCollSeq; /* All collating sequences */
509 BusyHandler busyHandler; /* Busy callback */
drhb9bb7c12006-06-11 23:41:55 +0000510 int busyTimeout; /* Busy handler timeout, in msec */
drhfcd35c72005-05-21 02:48:08 +0000511 Db aDbStatic[2]; /* Static space for the 2 default backends */
danielk19777e900ab2005-05-23 04:51:01 +0000512#ifdef SQLITE_SSE
513 sqlite3_stmt *pFetch; /* Used by SSE to fetch stored statements */
514#endif
danielk197741483462007-03-24 16:45:04 +0000515 u8 dfltLockMode; /* Default locking-mode for attached dbs */
drh75897232000-05-29 14:26:00 +0000516};
517
drh03b808a2006-03-13 15:06:05 +0000518/*
519** A macro to discover the encoding of a database.
520*/
danielk197714db2662006-01-09 16:12:04 +0000521#define ENC(db) ((db)->aDb[0].pSchema->enc)
522
drh75897232000-05-29 14:26:00 +0000523/*
drh8bf8dc92003-05-17 17:35:10 +0000524** Possible values for the sqlite.flags and or Db.flags fields.
525**
526** On sqlite.flags, the SQLITE_InTrans value means that we have
527** executed a BEGIN. On Db.flags, SQLITE_InTrans means a statement
528** transaction is active on that particular database file.
drh75897232000-05-29 14:26:00 +0000529*/
drh5e00f6c2001-09-13 13:46:56 +0000530#define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */
drh5e00f6c2001-09-13 13:46:56 +0000531#define SQLITE_InTrans 0x00000008 /* True if in a transaction */
532#define SQLITE_InternChanges 0x00000010 /* Uncommitted Hash table changes */
drh382c0242001-10-06 16:33:02 +0000533#define SQLITE_FullColNames 0x00000020 /* Show full column names on SELECT */
drhfcabd462004-02-20 14:50:58 +0000534#define SQLITE_ShortColNames 0x00000040 /* Show short columns names */
535#define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */
drh1bee3d72001-10-15 00:44:35 +0000536 /* DELETE, or UPDATE and return */
537 /* the count using a callback. */
drhfcabd462004-02-20 14:50:58 +0000538#define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */
drh6a535342001-10-19 16:44:56 +0000539 /* result set is empty */
drh35d4c2f2004-06-10 01:30:59 +0000540#define SQLITE_SqlTrace 0x00000200 /* Debug print SQL as it executes */
541#define SQLITE_VdbeListing 0x00000400 /* Debug listings of VDBE programs */
drhf4040832004-10-22 20:29:21 +0000542#define SQLITE_WriteSchema 0x00000800 /* OK to update SQLITE_MASTER */
drh7bec5052005-02-06 02:45:41 +0000543#define SQLITE_NoReadlock 0x00001000 /* Readlocks are omitted when
544 ** accessing read-only databases */
drh0cd2d4c2005-11-03 02:15:02 +0000545#define SQLITE_IgnoreChecks 0x00002000 /* Do not enforce check constraints */
drhc2e87a32006-06-27 15:16:14 +0000546#define SQLITE_ReadUncommitted 0x00004000 /* For shared-cache mode */
drhe321c292006-01-12 01:56:43 +0000547#define SQLITE_LegacyFileFmt 0x00008000 /* Create new databases in format 1 */
drhac530b12006-02-11 01:25:50 +0000548#define SQLITE_FullFSync 0x00010000 /* Use full fsync on the backend */
drhc2e87a32006-06-27 15:16:14 +0000549#define SQLITE_LoadExtension 0x00020000 /* Enable load_extension */
drh58b95762000-06-02 01:17:37 +0000550
danielk197734c68fb2007-03-14 15:37:04 +0000551#define SQLITE_RecoveryMode 0x00040000 /* Ignore schema errors */
drh4a50aac2007-08-23 02:47:53 +0000552#define SQLITE_SharedCache 0x00080000 /* Cache sharing is enabled */
553#define SQLITE_Vtab 0x00100000 /* There exists a virtual table */
danielk197734c68fb2007-03-14 15:37:04 +0000554
drh58b95762000-06-02 01:17:37 +0000555/*
drh247be432002-05-10 05:44:55 +0000556** Possible values for the sqlite.magic field.
557** The numbers are obtained at random and have no special meaning, other
558** than being distinct from one another.
559*/
560#define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */
561#define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */
562#define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */
563#define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */
564
565/*
drh0bce8352002-02-28 00:41:10 +0000566** Each SQL function is defined by an instance of the following
567** structure. A pointer to this structure is stored in the sqlite.aFunc
drh8e0a2f92002-02-23 23:45:45 +0000568** hash table. When multiple functions have the same name, the hash table
569** points to a linked list of these structures.
drh28037572000-08-02 13:47:41 +0000570*/
drh0bce8352002-02-28 00:41:10 +0000571struct FuncDef {
drh55ef4d92005-08-14 01:20:37 +0000572 i16 nArg; /* Number of arguments. -1 means unlimited */
danielk1977d8123362004-06-12 09:25:12 +0000573 u8 iPrefEnc; /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
drh55ef4d92005-08-14 01:20:37 +0000574 u8 needCollSeq; /* True if sqlite3GetFuncCollSeq() might be called */
575 u8 flags; /* Some combination of SQLITE_FUNC_* */
drhf9b596e2004-05-26 16:54:42 +0000576 void *pUserData; /* User data parameter */
577 FuncDef *pNext; /* Next function with same name */
578 void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
579 void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
580 void (*xFinalize)(sqlite3_context*); /* Aggregate finializer */
drh55ef4d92005-08-14 01:20:37 +0000581 char zName[1]; /* SQL name of the function. MUST BE LAST */
drh8e0a2f92002-02-23 23:45:45 +0000582};
drh28037572000-08-02 13:47:41 +0000583
584/*
danielk1977d1ab1ba2006-06-15 04:28:13 +0000585** Each SQLite module (virtual table definition) is defined by an
586** instance of the following structure, stored in the sqlite3.aModule
587** hash table.
588*/
589struct Module {
590 const sqlite3_module *pModule; /* Callback pointers */
591 const char *zName; /* Name passed to create_module() */
592 void *pAux; /* pAux passed to create_module() */
danielk1977832a58a2007-06-22 15:21:15 +0000593 void (*xDestroy)(void *); /* Module destructor function */
danielk1977d1ab1ba2006-06-15 04:28:13 +0000594};
595
596/*
drh55ef4d92005-08-14 01:20:37 +0000597** Possible values for FuncDef.flags
598*/
drhd64fe2f2005-08-28 17:00:23 +0000599#define SQLITE_FUNC_LIKE 0x01 /* Candidate for the LIKE optimization */
600#define SQLITE_FUNC_CASE 0x02 /* Case-sensitive LIKE-type function */
drhb7f6f682006-07-08 17:06:43 +0000601#define SQLITE_FUNC_EPHEM 0x04 /* Ephermeral. Delete with VDBE */
drh55ef4d92005-08-14 01:20:37 +0000602
603/*
drh967e8b72000-06-21 13:59:10 +0000604** information about each column of an SQL table is held in an instance
drh7020f652000-06-03 18:06:52 +0000605** of this structure.
606*/
607struct Column {
drh967e8b72000-06-21 13:59:10 +0000608 char *zName; /* Name of this column */
danielk19777977a172004-11-09 12:44:37 +0000609 Expr *pDflt; /* Default value of this column */
drh382c0242001-10-06 16:33:02 +0000610 char *zType; /* Data type for this column */
danielk1977b3bf5562006-01-10 17:58:23 +0000611 char *zColl; /* Collating sequence. If NULL, use the default */
drh4a324312001-12-21 14:30:42 +0000612 u8 notNull; /* True if there is a NOT NULL constraint */
drh78100cc2003-08-23 22:40:53 +0000613 u8 isPrimKey; /* True if this column is part of the PRIMARY KEY */
danielk1977a37cdde2004-05-16 11:15:36 +0000614 char affinity; /* One of the SQLITE_AFF_... values */
danielk1977034ca142007-06-26 10:38:54 +0000615#ifndef SQLITE_OMIT_VIRTUALTABLE
616 u8 isHidden; /* True if this column is 'hidden' */
617#endif
drh7020f652000-06-03 18:06:52 +0000618};
619
620/*
drha9fd84b2004-05-18 23:21:35 +0000621** A "Collating Sequence" is defined by an instance of the following
danielk19770202b292004-06-09 09:55:16 +0000622** structure. Conceptually, a collating sequence consists of a name and
623** a comparison routine that defines the order of that sequence.
drha9fd84b2004-05-18 23:21:35 +0000624**
danielk19770202b292004-06-09 09:55:16 +0000625** There may two seperate implementations of the collation function, one
626** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
627** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
628** native byte order. When a collation sequence is invoked, SQLite selects
629** the version that will require the least expensive encoding
danielk1977b3bf5562006-01-10 17:58:23 +0000630** translations, if any.
danielk19770202b292004-06-09 09:55:16 +0000631**
632** The CollSeq.pUser member variable is an extra parameter that passed in
633** as the first argument to the UTF-8 comparison function, xCmp.
634** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
635** xCmp16.
636**
637** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
638** collating sequence is undefined. Indices built on an undefined
639** collating sequence may not be read or written.
drha9fd84b2004-05-18 23:21:35 +0000640*/
641struct CollSeq {
danielk1977a9808b32007-05-07 09:32:45 +0000642 char *zName; /* Name of the collating sequence, UTF-8 encoded */
643 u8 enc; /* Text encoding handled by xCmp() */
644 u8 type; /* One of the SQLITE_COLL_... values below */
645 void *pUser; /* First argument to xCmp() */
danielk19770202b292004-06-09 09:55:16 +0000646 int (*xCmp)(void*,int, const void*, int, const void*);
danielk1977a9808b32007-05-07 09:32:45 +0000647 void (*xDel)(void*); /* Destructor for pUser */
drha9fd84b2004-05-18 23:21:35 +0000648};
649
650/*
drhd64fe2f2005-08-28 17:00:23 +0000651** Allowed values of CollSeq flags:
652*/
653#define SQLITE_COLL_BINARY 1 /* The default memcmp() collating sequence */
654#define SQLITE_COLL_NOCASE 2 /* The built-in NOCASE collating sequence */
655#define SQLITE_COLL_REVERSE 3 /* The built-in REVERSE collating sequence */
656#define SQLITE_COLL_USER 0 /* Any other user-defined collating sequence */
657
658/*
drhd3d39e92004-05-20 22:16:29 +0000659** A sort order can be either ASC or DESC.
drh8e2ca022002-06-17 17:07:19 +0000660*/
drh8e2ca022002-06-17 17:07:19 +0000661#define SQLITE_SO_ASC 0 /* Sort in ascending order */
drhd3d39e92004-05-20 22:16:29 +0000662#define SQLITE_SO_DESC 1 /* Sort in ascending order */
drh8e2ca022002-06-17 17:07:19 +0000663
664/*
danielk1977a37cdde2004-05-16 11:15:36 +0000665** Column affinity types.
drh8a512562005-11-14 22:29:05 +0000666**
667** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
668** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve
669** the speed a little by number the values consecutively.
670**
671** But rather than start with 0 or 1, we begin with 'a'. That way,
672** when multiple affinity types are concatenated into a string and
673** used as the P3 operand, they will be more readable.
674**
675** Note also that the numeric types are grouped together so that testing
676** for a numeric type is a single comparison.
danielk1977a37cdde2004-05-16 11:15:36 +0000677*/
drh8a512562005-11-14 22:29:05 +0000678#define SQLITE_AFF_TEXT 'a'
679#define SQLITE_AFF_NONE 'b'
680#define SQLITE_AFF_NUMERIC 'c'
681#define SQLITE_AFF_INTEGER 'd'
682#define SQLITE_AFF_REAL 'e'
danielk1977a37cdde2004-05-16 11:15:36 +0000683
drh8a512562005-11-14 22:29:05 +0000684#define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC)
danielk1977a37cdde2004-05-16 11:15:36 +0000685
686/*
drh22f70c32002-02-18 01:17:00 +0000687** Each SQL table is represented in memory by an instance of the
688** following structure.
689**
drhd24cc422003-03-27 12:51:24 +0000690** Table.zName is the name of the table. The case of the original
drh22f70c32002-02-18 01:17:00 +0000691** CREATE TABLE statement is stored, but case is not significant for
692** comparisons.
693**
drhd24cc422003-03-27 12:51:24 +0000694** Table.nCol is the number of columns in this table. Table.aCol is a
drh22f70c32002-02-18 01:17:00 +0000695** pointer to an array of Column structures, one for each column.
696**
drhd24cc422003-03-27 12:51:24 +0000697** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
698** the column that is that key. Otherwise Table.iPKey is negative. Note
drh22f70c32002-02-18 01:17:00 +0000699** that the datatype of the PRIMARY KEY must be INTEGER for this field to
700** be set. An INTEGER PRIMARY KEY is used as the rowid for each row of
701** the table. If a table has no INTEGER PRIMARY KEY, then a random rowid
drhd24cc422003-03-27 12:51:24 +0000702** is generated for each row of the table. Table.hasPrimKey is true if
drh22f70c32002-02-18 01:17:00 +0000703** the table has any PRIMARY KEY, INTEGER or otherwise.
704**
drhd24cc422003-03-27 12:51:24 +0000705** Table.tnum is the page number for the root BTree page of the table in the
706** database file. If Table.iDb is the index of the database table backend
707** in sqlite.aDb[]. 0 is for the main database and 1 is for the file that
drhb9bb7c12006-06-11 23:41:55 +0000708** holds temporary tables and indices. If Table.isEphem
drh22f70c32002-02-18 01:17:00 +0000709** is true, then the table is stored in a file that is automatically deleted
drhd24cc422003-03-27 12:51:24 +0000710** when the VDBE cursor to the table is closed. In this case Table.tnum
drh22f70c32002-02-18 01:17:00 +0000711** refers VDBE cursor number that holds the table open, not to the root
712** page number. Transient tables are used to hold the results of a
713** sub-query that appears instead of a real table name in the FROM clause
714** of a SELECT statement.
drh75897232000-05-29 14:26:00 +0000715*/
716struct Table {
drh967e8b72000-06-21 13:59:10 +0000717 char *zName; /* Name of the table */
drh967e8b72000-06-21 13:59:10 +0000718 int nCol; /* Number of columns in this table */
719 Column *aCol; /* Information about each column */
drhc8392582001-12-31 02:48:51 +0000720 int iPKey; /* If not less then 0, use aCol[iPKey] as the primary key */
drh967e8b72000-06-21 13:59:10 +0000721 Index *pIndex; /* List of SQL indexes on this table. */
drh22f70c32002-02-18 01:17:00 +0000722 int tnum; /* Root BTree node for this table (see note above) */
drha76b5df2002-02-23 02:32:10 +0000723 Select *pSelect; /* NULL for tables. Points to definition if a view. */
drhed8a3bb2005-06-06 21:19:56 +0000724 int nRef; /* Number of pointers to this Table */
danielk1977c3f9bad2002-05-15 08:30:12 +0000725 Trigger *pTrigger; /* List of SQL triggers on this table */
drhc2eef3b2002-08-31 18:53:06 +0000726 FKey *pFKey; /* Linked list of all foreign keys in this table */
danielk19773d1bfea2004-05-14 11:00:53 +0000727 char *zColAff; /* String defining the affinity of each column */
drhffe07b22005-11-03 00:41:17 +0000728#ifndef SQLITE_OMIT_CHECK
729 Expr *pCheck; /* The AND of all CHECK constraints */
730#endif
danielk197719a8e7e2005-03-17 05:03:38 +0000731#ifndef SQLITE_OMIT_ALTERTABLE
732 int addColOffset; /* Offset in CREATE TABLE statement to add a new column */
733#endif
drh19146192006-06-26 19:10:32 +0000734 u8 readOnly; /* True if this table should not be written by the user */
735 u8 isEphem; /* True if created using OP_OpenEphermeral */
736 u8 hasPrimKey; /* True if there exists a primary key */
737 u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */
738 u8 autoInc; /* True if the integer primary key is autoincrement */
drhe09daa92006-06-10 13:29:31 +0000739#ifndef SQLITE_OMIT_VIRTUALTABLE
drh19146192006-06-26 19:10:32 +0000740 u8 isVirtual; /* True if this is a virtual table */
741 u8 isCommit; /* True once the CREATE TABLE has been committed */
danielk1977d1ab1ba2006-06-15 04:28:13 +0000742 Module *pMod; /* Pointer to the implementation of the module */
drhb9bb7c12006-06-11 23:41:55 +0000743 sqlite3_vtab *pVtab; /* Pointer to the module instance */
744 int nModuleArg; /* Number of arguments to the module */
745 char **azModuleArg; /* Text of all module args. [0] is module name */
drhe09daa92006-06-10 13:29:31 +0000746#endif
drh728b5772007-09-18 15:55:07 +0000747 Schema *pSchema; /* Schema that contains this table */
drh75897232000-05-29 14:26:00 +0000748};
749
750/*
drh4cbdda92006-06-14 19:00:20 +0000751** Test to see whether or not a table is a virtual table. This is
752** done as a macro so that it will be optimized out when virtual
753** table support is omitted from the build.
754*/
755#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977034ca142007-06-26 10:38:54 +0000756# define IsVirtual(X) ((X)->isVirtual)
757# define IsHiddenColumn(X) ((X)->isHidden)
drh4cbdda92006-06-14 19:00:20 +0000758#else
danielk1977034ca142007-06-26 10:38:54 +0000759# define IsVirtual(X) 0
760# define IsHiddenColumn(X) 0
drh4cbdda92006-06-14 19:00:20 +0000761#endif
762
763/*
drhc2eef3b2002-08-31 18:53:06 +0000764** Each foreign key constraint is an instance of the following structure.
765**
766** A foreign key is associated with two tables. The "from" table is
767** the table that contains the REFERENCES clause that creates the foreign
768** key. The "to" table is the table that is named in the REFERENCES clause.
769** Consider this example:
770**
771** CREATE TABLE ex1(
772** a INTEGER PRIMARY KEY,
773** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
774** );
775**
776** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
777**
778** Each REFERENCES clause generates an instance of the following structure
779** which is attached to the from-table. The to-table need not exist when
780** the from-table is created. The existance of the to-table is not checked
781** until an attempt is made to insert data into the from-table.
782**
drhea1ba172003-04-20 00:00:23 +0000783** The sqlite.aFKey hash table stores pointers to this structure
drhc2eef3b2002-08-31 18:53:06 +0000784** given the name of a to-table. For each to-table, all foreign keys
785** associated with that table are on a linked list using the FKey.pNextTo
786** field.
787*/
788struct FKey {
789 Table *pFrom; /* The table that constains the REFERENCES clause */
790 FKey *pNextFrom; /* Next foreign key in pFrom */
791 char *zTo; /* Name of table that the key points to */
792 FKey *pNextTo; /* Next foreign key that points to zTo */
793 int nCol; /* Number of columns in this key */
794 struct sColMap { /* Mapping of columns in pFrom to columns in zTo */
795 int iFrom; /* Index of column in pFrom */
796 char *zCol; /* Name of column in zTo. If 0 use PRIMARY KEY */
797 } *aCol; /* One entry for each of nCol column s */
798 u8 isDeferred; /* True if constraint checking is deferred till COMMIT */
799 u8 updateConf; /* How to resolve conflicts that occur on UPDATE */
800 u8 deleteConf; /* How to resolve conflicts that occur on DELETE */
801 u8 insertConf; /* How to resolve conflicts that occur on INSERT */
802};
803
804/*
danielk1977aaa40c12007-09-21 04:28:16 +0000805** SQLite supports many different ways to resolve a constraint
drh22f70c32002-02-18 01:17:00 +0000806** error. ROLLBACK processing means that a constraint violation
drh0bd1f4e2002-06-06 18:54:39 +0000807** causes the operation in process to fail and for the current transaction
drh1c928532002-01-31 15:54:21 +0000808** to be rolled back. ABORT processing means the operation in process
809** fails and any prior changes from that one operation are backed out,
810** but the transaction is not rolled back. FAIL processing means that
811** the operation in progress stops and returns an error code. But prior
812** changes due to the same operation are not backed out and no rollback
813** occurs. IGNORE means that the particular row that caused the constraint
814** error is not inserted or updated. Processing continues and no error
815** is returned. REPLACE means that preexisting database rows that caused
816** a UNIQUE constraint violation are removed so that the new insert or
817** update can proceed. Processing continues and no error is reported.
drhc2eef3b2002-08-31 18:53:06 +0000818**
819** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
820** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
821** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign
822** key is set to NULL. CASCADE means that a DELETE or UPDATE of the
823** referenced table row is propagated into the row that holds the
824** foreign key.
drh1c928532002-01-31 15:54:21 +0000825**
drh968af522003-02-11 14:55:40 +0000826** The following symbolic values are used to record which type
drh1c928532002-01-31 15:54:21 +0000827** of action to take.
drh9cfcf5d2002-01-29 18:41:24 +0000828*/
drh1c928532002-01-31 15:54:21 +0000829#define OE_None 0 /* There is no constraint to check */
830#define OE_Rollback 1 /* Fail the operation and rollback the transaction */
831#define OE_Abort 2 /* Back out changes but do no rollback transaction */
832#define OE_Fail 3 /* Stop the operation but leave all prior changes */
833#define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */
834#define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */
drhc2eef3b2002-08-31 18:53:06 +0000835
836#define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
837#define OE_SetNull 7 /* Set the foreign key value to NULL */
838#define OE_SetDflt 8 /* Set the foreign key value to its default */
839#define OE_Cascade 9 /* Cascade the changes */
840
841#define OE_Default 99 /* Do whatever the default action is */
drh9cfcf5d2002-01-29 18:41:24 +0000842
drhd3d39e92004-05-20 22:16:29 +0000843
844/*
845** An instance of the following structure is passed as the first
846** argument to sqlite3VdbeKeyCompare and is used to control the
847** comparison of the two index keys.
848**
849** If the KeyInfo.incrKey value is true and the comparison would
drh7e627792005-04-29 02:10:00 +0000850** otherwise be equal, then return a result as if the second key
851** were larger.
drhd3d39e92004-05-20 22:16:29 +0000852*/
853struct KeyInfo {
drhb21c8cd2007-08-21 19:33:56 +0000854 sqlite3 *db; /* The database connection */
danielk1977b1bc9532004-05-22 03:05:33 +0000855 u8 enc; /* Text encoding - one of the TEXT_Utf* values */
drhd3d39e92004-05-20 22:16:29 +0000856 u8 incrKey; /* Increase 2nd key by epsilon before comparison */
857 int nField; /* Number of entries in aColl[] */
drhd2d4a6b2006-01-10 15:18:27 +0000858 u8 *aSortOrder; /* If defined an aSortOrder[i] is true, sort DESC */
drhd3d39e92004-05-20 22:16:29 +0000859 CollSeq *aColl[1]; /* Collating sequence for each term of the key */
860};
861
drh9cfcf5d2002-01-29 18:41:24 +0000862/*
drh66b89c82000-11-28 20:47:17 +0000863** Each SQL index is represented in memory by an
drh75897232000-05-29 14:26:00 +0000864** instance of the following structure.
drh967e8b72000-06-21 13:59:10 +0000865**
866** The columns of the table that are to be indexed are described
867** by the aiColumn[] field of this structure. For example, suppose
868** we have the following table and index:
869**
870** CREATE TABLE Ex1(c1 int, c2 int, c3 text);
871** CREATE INDEX Ex2 ON Ex1(c3,c1);
872**
873** In the Table structure describing Ex1, nCol==3 because there are
874** three columns in the table. In the Index structure describing
875** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
876** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the
877** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
878** The second column to be indexed (c1) has an index of 0 in
879** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
drhea1ba172003-04-20 00:00:23 +0000880**
881** The Index.onError field determines whether or not the indexed columns
882** must be unique and what to do if they are not. When Index.onError=OE_None,
883** it means this is not a unique index. Otherwise it is a unique index
884** and the value of Index.onError indicate the which conflict resolution
885** algorithm to employ whenever an attempt is made to insert a non-unique
886** element.
drh75897232000-05-29 14:26:00 +0000887*/
888struct Index {
drh967e8b72000-06-21 13:59:10 +0000889 char *zName; /* Name of this index */
drh967e8b72000-06-21 13:59:10 +0000890 int nColumn; /* Number of columns in the table used by this index */
891 int *aiColumn; /* Which columns are used by this index. 1st is 0 */
drh8b3d9902005-08-19 00:14:42 +0000892 unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
drh967e8b72000-06-21 13:59:10 +0000893 Table *pTable; /* The SQL table being indexed */
drhbe0072d2001-09-13 14:46:09 +0000894 int tnum; /* Page containing root of this index in database file */
drh9cfcf5d2002-01-29 18:41:24 +0000895 u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
drh485b39b2002-07-13 03:11:52 +0000896 u8 autoIndex; /* True if is automatically created (ex: by UNIQUE) */
danielk1977a37cdde2004-05-16 11:15:36 +0000897 char *zColAff; /* String defining the affinity of each column */
drh967e8b72000-06-21 13:59:10 +0000898 Index *pNext; /* The next index associated with the same table */
danielk1977b3bf5562006-01-10 17:58:23 +0000899 Schema *pSchema; /* Schema containing this index */
900 u8 *aSortOrder; /* Array of size Index.nColumn. True==DESC, False==ASC */
901 char **azColl; /* Array of collation sequence names for index */
drh75897232000-05-29 14:26:00 +0000902};
903
904/*
905** Each token coming out of the lexer is an instance of
drh4b59ab52002-08-24 18:24:51 +0000906** this structure. Tokens are also used as part of an expression.
drh4efc4752004-01-16 15:55:37 +0000907**
908** Note if Token.z==0 then Token.dyn and Token.n are undefined and
909** may contain random values. Do not make any assuptions about Token.dyn
910** and Token.n when Token.z==0.
drh75897232000-05-29 14:26:00 +0000911*/
912struct Token {
drh4c755c02004-08-08 20:22:17 +0000913 const unsigned char *z; /* Text of the token. Not NULL-terminated! */
914 unsigned dyn : 1; /* True for malloced memory, false for static */
915 unsigned n : 31; /* Number of characters in this token */
drh75897232000-05-29 14:26:00 +0000916};
917
918/*
drh13449892005-09-07 21:22:45 +0000919** An instance of this structure contains information needed to generate
920** code for a SELECT that contains aggregate functions.
921**
922** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
923** pointer to this structure. The Expr.iColumn field is the index in
924** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
925** code for that node.
926**
927** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
928** original Select structure that describes the SELECT statement. These
929** fields do not need to be freed when deallocating the AggInfo structure.
930*/
931struct AggInfo {
932 u8 directMode; /* Direct rendering mode means take data directly
933 ** from source tables rather than from accumulators */
934 u8 useSortingIdx; /* In direct mode, reference the sorting index rather
935 ** than the source table */
936 int sortingIdx; /* Cursor number of the sorting index */
937 ExprList *pGroupBy; /* The group by clause */
938 int nSortingColumn; /* Number of columns in the sorting index */
939 struct AggInfo_col { /* For each column used in source tables */
danielk19770817d0d2007-02-14 09:19:36 +0000940 Table *pTab; /* Source table */
drh13449892005-09-07 21:22:45 +0000941 int iTable; /* Cursor number of the source table */
942 int iColumn; /* Column number within the source table */
943 int iSorterColumn; /* Column number in the sorting index */
944 int iMem; /* Memory location that acts as accumulator */
drh5774b802005-09-07 22:48:16 +0000945 Expr *pExpr; /* The original expression */
drh13449892005-09-07 21:22:45 +0000946 } *aCol;
947 int nColumn; /* Number of used entries in aCol[] */
948 int nColumnAlloc; /* Number of slots allocated for aCol[] */
949 int nAccumulator; /* Number of columns that show through to the output.
950 ** Additional columns are used only as parameters to
951 ** aggregate functions */
952 struct AggInfo_func { /* For each aggregate function */
953 Expr *pExpr; /* Expression encoding the function */
954 FuncDef *pFunc; /* The aggregate function implementation */
955 int iMem; /* Memory location that acts as accumulator */
drhb9bb7c12006-06-11 23:41:55 +0000956 int iDistinct; /* Ephermeral table used to enforce DISTINCT */
drh13449892005-09-07 21:22:45 +0000957 } *aFunc;
958 int nFunc; /* Number of entries in aFunc[] */
959 int nFuncAlloc; /* Number of slots allocated for aFunc[] */
960};
961
962/*
drh75897232000-05-29 14:26:00 +0000963** Each node of an expression in the parse tree is an instance
drh22f70c32002-02-18 01:17:00 +0000964** of this structure.
965**
966** Expr.op is the opcode. The integer parser token codes are reused
967** as opcodes here. For example, the parser defines TK_GE to be an integer
968** code representing the ">=" operator. This same integer code is reused
969** to represent the greater-than-or-equal-to operator in the expression
970** tree.
971**
972** Expr.pRight and Expr.pLeft are subexpressions. Expr.pList is a list
973** of argument if the expression is a function.
974**
drh4b59ab52002-08-24 18:24:51 +0000975** Expr.token is the operator token for this node. For some expressions
976** that have subexpressions, Expr.token can be the complete text that gave
977** rise to the Expr. In the latter case, the token is marked as being
978** a compound token.
drh22f70c32002-02-18 01:17:00 +0000979**
980** An expression of the form ID or ID.ID refers to a column in a table.
981** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
982** the integer cursor number of a VDBE cursor pointing to that table and
983** Expr.iColumn is the column number for the specific column. If the
984** expression is used as a result in an aggregate SELECT, then the
985** value is also stored in the Expr.iAgg column in the aggregate so that
986** it can be accessed after all aggregates are computed.
987**
988** If the expression is a function, the Expr.iTable is an integer code
drh7c972de2003-09-06 22:18:07 +0000989** representing which function. If the expression is an unbound variable
990** marker (a question mark character '?' in the original SQL) then the
991** Expr.iTable holds the index number for that variable.
drh22f70c32002-02-18 01:17:00 +0000992**
drh1398ad32005-01-19 23:24:50 +0000993** If the expression is a subquery then Expr.iColumn holds an integer
994** register number containing the result of the subquery. If the
995** subquery gives a constant result, then iTable is -1. If the subquery
996** gives a different answer at different times during statement processing
997** then iTable is the address of a subroutine that computes the subquery.
998**
drh22f70c32002-02-18 01:17:00 +0000999** The Expr.pSelect field points to a SELECT statement. The SELECT might
1000** be the right operand of an IN operator. Or, if a scalar SELECT appears
1001** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
1002** operand.
danielk1977aee18ef2005-03-09 12:26:50 +00001003**
1004** If the Expr is of type OP_Column, and the table it is selecting from
1005** is a disk table or the "old.*" pseudo-table, then pTab points to the
1006** corresponding table definition.
drh75897232000-05-29 14:26:00 +00001007*/
1008struct Expr {
drh1cc093c2002-06-24 22:01:57 +00001009 u8 op; /* Operation performed by this node */
drha9fd84b2004-05-18 23:21:35 +00001010 char affinity; /* The affinity of the column or 0 if not a column */
drh6a03a1c2006-07-08 18:34:59 +00001011 u16 flags; /* Various flags. See below */
drhf2bc0132004-10-04 13:19:23 +00001012 CollSeq *pColl; /* The collation type of the column or 0 */
drh75897232000-05-29 14:26:00 +00001013 Expr *pLeft, *pRight; /* Left and right subnodes */
drhd99f7062002-06-08 23:25:08 +00001014 ExprList *pList; /* A list of expressions used as function arguments
1015 ** or in "<expr> IN (<expr-list)" */
drh75897232000-05-29 14:26:00 +00001016 Token token; /* An operand token */
drh6977fea2002-10-22 23:38:04 +00001017 Token span; /* Complete text of the expression */
drh967e8b72000-06-21 13:59:10 +00001018 int iTable, iColumn; /* When op==TK_COLUMN, then this expr node means the
drh8e2ca022002-06-17 17:07:19 +00001019 ** iColumn-th field of the iTable-th table. */
drh13449892005-09-07 21:22:45 +00001020 AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
1021 int iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
drh22d6a532005-09-19 21:05:48 +00001022 int iRightJoinTable; /* If EP_FromJoin, the right table of the join */
drhd99f7062002-06-08 23:25:08 +00001023 Select *pSelect; /* When the expression is a sub-select. Also the
1024 ** right side of "<expr> IN (<select>)" */
danielk1977aee18ef2005-03-09 12:26:50 +00001025 Table *pTab; /* Table for OP_Column expressions. */
drh728b5772007-09-18 15:55:07 +00001026/* Schema *pSchema; */
danielk1977e6a58a42007-08-31 17:42:48 +00001027#if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
danielk1977fc976062007-05-10 10:46:56 +00001028 int nHeight; /* Height of the tree headed by this node */
1029#endif
drh75897232000-05-29 14:26:00 +00001030};
1031
1032/*
drh1f162302002-10-27 19:35:33 +00001033** The following are the meanings of bits in the Expr.flags field.
1034*/
drh392e5972005-07-08 14:14:22 +00001035#define EP_FromJoin 0x01 /* Originated in ON or USING clause of a join */
1036#define EP_Agg 0x02 /* Contains one or more aggregate functions */
1037#define EP_Resolved 0x04 /* IDs have been resolved to COLUMNs */
1038#define EP_Error 0x08 /* Expression contains one or more errors */
drhfd357972005-09-09 01:33:19 +00001039#define EP_Distinct 0x10 /* Aggregate function with DISTINCT keyword */
drh392e5972005-07-08 14:14:22 +00001040#define EP_VarSelect 0x20 /* pSelect is correlated, not constant */
drhd2687b72005-08-12 22:56:09 +00001041#define EP_Dequoted 0x40 /* True if the string has been dequoted */
drh6a03a1c2006-07-08 18:34:59 +00001042#define EP_InfixFunc 0x80 /* True for an infix function: LIKE, GLOB, etc */
drh8b4c40d2007-02-01 23:02:45 +00001043#define EP_ExpCollate 0x100 /* Collating sequence specified explicitly */
drh1f162302002-10-27 19:35:33 +00001044
1045/*
1046** These macros can be used to test, set, or clear bits in the
1047** Expr.flags field.
1048*/
1049#define ExprHasProperty(E,P) (((E)->flags&(P))==(P))
1050#define ExprHasAnyProperty(E,P) (((E)->flags&(P))!=0)
1051#define ExprSetProperty(E,P) (E)->flags|=(P)
1052#define ExprClearProperty(E,P) (E)->flags&=~(P)
1053
1054/*
drh75897232000-05-29 14:26:00 +00001055** A list of expressions. Each expression may optionally have a
1056** name. An expr/name combination can be used in several ways, such
1057** as the list of "expr AS ID" fields following a "SELECT" or in the
1058** list of "ID = expr" items in an UPDATE. A list of expressions can
drhad3cab52002-05-24 02:04:32 +00001059** also be used as the argument to a function, in which case the a.zName
drh75897232000-05-29 14:26:00 +00001060** field is not used.
1061*/
1062struct ExprList {
1063 int nExpr; /* Number of expressions on the list */
drh4305d102003-07-30 12:34:12 +00001064 int nAlloc; /* Number of entries allocated below */
drh9d2985c2005-09-08 01:58:42 +00001065 int iECursor; /* VDBE Cursor associated with this ExprList */
drh6d4abfb2001-10-22 02:58:08 +00001066 struct ExprList_item {
drh75897232000-05-29 14:26:00 +00001067 Expr *pExpr; /* The list of expressions */
1068 char *zName; /* Token associated with this expression */
drh8e2ca022002-06-17 17:07:19 +00001069 u8 sortOrder; /* 1 for DESC or 0 for ASC */
1070 u8 isAgg; /* True if this is an aggregate like count(*) */
1071 u8 done; /* A flag to indicate when processing is finished */
drh75897232000-05-29 14:26:00 +00001072 } *a; /* One entry for each expression */
1073};
1074
1075/*
drhad3cab52002-05-24 02:04:32 +00001076** An instance of this structure can hold a simple list of identifiers,
1077** such as the list "a,b,c" in the following statements:
1078**
1079** INSERT INTO t(a,b,c) VALUES ...;
1080** CREATE INDEX idx ON t(a,b,c);
1081** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1082**
1083** The IdList.a.idx field is used when the IdList represents the list of
1084** column names after a table name in an INSERT statement. In the statement
1085**
1086** INSERT INTO t(a,b,c) ...
1087**
1088** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
drh75897232000-05-29 14:26:00 +00001089*/
1090struct IdList {
drh6d4abfb2001-10-22 02:58:08 +00001091 struct IdList_item {
drhad3cab52002-05-24 02:04:32 +00001092 char *zName; /* Name of the identifier */
drh967e8b72000-06-21 13:59:10 +00001093 int idx; /* Index in some Table.aCol[] of a column named zName */
drhad3cab52002-05-24 02:04:32 +00001094 } *a;
drh13449892005-09-07 21:22:45 +00001095 int nId; /* Number of identifiers on the list */
1096 int nAlloc; /* Number of entries allocated for a[] below */
drhad3cab52002-05-24 02:04:32 +00001097};
1098
1099/*
drh51669862004-12-18 18:40:26 +00001100** The bitmask datatype defined below is used for various optimizations.
drhca83ac52007-02-01 01:40:44 +00001101**
1102** Changing this from a 64-bit to a 32-bit type limits the number of
1103** tables in a join to 32 instead of 64. But it also reduces the size
1104** of the library by 738 bytes on ix86.
drh51669862004-12-18 18:40:26 +00001105*/
drhca83ac52007-02-01 01:40:44 +00001106typedef u64 Bitmask;
drh51669862004-12-18 18:40:26 +00001107
1108/*
drhad3cab52002-05-24 02:04:32 +00001109** The following structure describes the FROM clause of a SELECT statement.
1110** Each table or subquery in the FROM clause is a separate element of
1111** the SrcList.a[] array.
drhd24cc422003-03-27 12:51:24 +00001112**
1113** With the addition of multiple database support, the following structure
1114** can also be used to describe a particular table such as the table that
1115** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL,
1116** such a table must be a simple name: ID. But in SQLite, the table can
1117** now be identified by a database name, a dot, then the table name: ID.ID.
drhc49de5d2007-01-19 01:06:01 +00001118**
1119** The jointype starts out showing the join type between the current table
1120** and the next table on the list. The parser builds the list this way.
1121** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
1122** jointype expresses the join between the table and the previous table.
drhad3cab52002-05-24 02:04:32 +00001123*/
1124struct SrcList {
drh939a16d2004-07-15 13:37:22 +00001125 i16 nSrc; /* Number of tables or subqueries in the FROM clause */
1126 i16 nAlloc; /* Number of entries allocated in a[] below */
drhad3cab52002-05-24 02:04:32 +00001127 struct SrcList_item {
drh113088e2003-03-20 01:16:58 +00001128 char *zDatabase; /* Name of database holding this table */
drhad3cab52002-05-24 02:04:32 +00001129 char *zName; /* Name of the table */
1130 char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */
drhdaffd0e2001-04-11 14:28:42 +00001131 Table *pTab; /* An SQL table corresponding to zName */
1132 Select *pSelect; /* A SELECT statement used in place of a table name */
danielk19771787cca2006-02-10 07:07:14 +00001133 u8 isPopulated; /* Temporary table associated with SELECT is populated */
drhc49de5d2007-01-19 01:06:01 +00001134 u8 jointype; /* Type of join between this able and the previous */
drhe68fbe72007-02-13 12:49:24 +00001135 int iCursor; /* The VDBE cursor number used to access this table */
drhad3cab52002-05-24 02:04:32 +00001136 Expr *pOn; /* The ON clause of a join */
1137 IdList *pUsing; /* The USING clause of a join */
drh51669862004-12-18 18:40:26 +00001138 Bitmask colUsed; /* Bit N (1<<N) set if column N or pTab is used */
drh113088e2003-03-20 01:16:58 +00001139 } a[1]; /* One entry for each identifier on the list */
drh75897232000-05-29 14:26:00 +00001140};
1141
1142/*
drh01f3f252002-05-24 16:14:15 +00001143** Permitted values of the SrcList.a.jointype field
1144*/
1145#define JT_INNER 0x0001 /* Any kind of inner or cross join */
drh3dec2232005-09-10 15:28:09 +00001146#define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */
1147#define JT_NATURAL 0x0004 /* True for a "natural" join */
1148#define JT_LEFT 0x0008 /* Left outer join */
1149#define JT_RIGHT 0x0010 /* Right outer join */
1150#define JT_OUTER 0x0020 /* The "OUTER" keyword is present */
1151#define JT_ERROR 0x0040 /* unknown or unsupported join type */
drh01f3f252002-05-24 16:14:15 +00001152
1153/*
drh6b563442001-11-07 16:48:26 +00001154** For each nested loop in a WHERE clause implementation, the WhereInfo
1155** structure contains a single instance of this structure. This structure
1156** is intended to be private the the where.c module and should not be
1157** access or modified by other modules.
drh6d209d82006-06-27 01:54:26 +00001158**
1159** The pIdxInfo and pBestIdx fields are used to help pick the best
1160** index on a virtual table. The pIdxInfo pointer contains indexing
1161** information for the i-th table in the FROM clause before reordering.
1162** All the pIdxInfo pointers are freed by whereInfoFree() in where.c.
1163** The pBestIdx pointer is a copy of pIdxInfo for the i-th table after
1164** FROM clause ordering. This is a little confusing so I will repeat
1165** it in different words. WhereInfo.a[i].pIdxInfo is index information
1166** for WhereInfo.pTabList.a[i]. WhereInfo.a[i].pBestInfo is the
1167** index information for the i-th loop of the join. pBestInfo is always
1168** either NULL or a copy of some pIdxInfo. So for cleanup it is
1169** sufficient to free all of the pIdxInfo pointers.
1170**
drh6b563442001-11-07 16:48:26 +00001171*/
1172struct WhereLevel {
drh29dda4a2005-07-21 18:23:20 +00001173 int iFrom; /* Which entry in the FROM clause */
1174 int flags; /* Flags associated with this level */
drh51147ba2005-07-23 22:59:55 +00001175 int iMem; /* First memory cell used by this level */
drh29dda4a2005-07-21 18:23:20 +00001176 int iLeftJoin; /* Memory cell used to implement LEFT OUTER JOIN */
1177 Index *pIdx; /* Index used. NULL if no index */
1178 int iTabCur; /* The VDBE cursor used to access the table */
1179 int iIdxCur; /* The VDBE cursor used to acesss pIdx */
1180 int brk; /* Jump here to break out of the loop */
drh72e8fa42007-03-28 14:30:06 +00001181 int nxt; /* Jump here to start the next IN combination */
drh29dda4a2005-07-21 18:23:20 +00001182 int cont; /* Jump here to continue with the next loop cycle */
1183 int top; /* First instruction of interior of the loop */
1184 int op, p1, p2; /* Opcode used to terminate the loop */
drh51147ba2005-07-23 22:59:55 +00001185 int nEq; /* Number of == or IN constraints on this loop */
drhe23399f2005-07-22 00:31:39 +00001186 int nIn; /* Number of IN operators constraining this loop */
drh72e8fa42007-03-28 14:30:06 +00001187 struct InLoop {
1188 int iCur; /* The VDBE cursor used by this IN operator */
1189 int topAddr; /* Top of the IN loop */
1190 } *aInLoop; /* Information about each nested IN operator */
drh6d209d82006-06-27 01:54:26 +00001191 sqlite3_index_info *pBestIdx; /* Index information for this level */
1192
1193 /* The following field is really not part of the current level. But
1194 ** we need a place to cache index information for each table in the
1195 ** FROM clause and the WhereLevel structure is a convenient place.
1196 */
1197 sqlite3_index_info *pIdxInfo; /* Index info for n-th source table */
drh6b563442001-11-07 16:48:26 +00001198};
1199
1200/*
drh75897232000-05-29 14:26:00 +00001201** The WHERE clause processing routine has two halves. The
1202** first part does the start of the WHERE loop and the second
1203** half does the tail of the WHERE loop. An instance of
1204** this structure is returned by the first half and passed
1205** into the second half to give some continuity.
1206*/
1207struct WhereInfo {
1208 Parse *pParse;
drhad3cab52002-05-24 02:04:32 +00001209 SrcList *pTabList; /* List of tables in the join */
drh9012bcb2004-12-19 00:11:35 +00001210 int iTop; /* The very beginning of the WHERE loop */
drh19a775c2000-06-05 18:54:46 +00001211 int iContinue; /* Jump here to continue with next record */
1212 int iBreak; /* Jump here to break out of the loop */
drh6b563442001-11-07 16:48:26 +00001213 int nLevel; /* Number of nested loop */
drh6d209d82006-06-27 01:54:26 +00001214 sqlite3_index_info **apInfo; /* Array of pointers to index info structures */
drh6b563442001-11-07 16:48:26 +00001215 WhereLevel a[1]; /* Information about each nest loop in the WHERE */
drh75897232000-05-29 14:26:00 +00001216};
1217
1218/*
danielk1977b3bce662005-01-29 08:32:43 +00001219** A NameContext defines a context in which to resolve table and column
1220** names. The context consists of a list of tables (the pSrcList) field and
1221** a list of named expression (pEList). The named expression list may
1222** be NULL. The pSrc corresponds to the FROM clause of a SELECT or
1223** to the table being operated on by INSERT, UPDATE, or DELETE. The
1224** pEList corresponds to the result set of a SELECT and is NULL for
1225** other statements.
1226**
1227** NameContexts can be nested. When resolving names, the inner-most
1228** context is searched first. If no match is found, the next outer
1229** context is checked. If there is still no match, the next context
1230** is checked. This process continues until either a match is found
1231** or all contexts are check. When a match is found, the nRef member of
1232** the context containing the match is incremented.
1233**
1234** Each subquery gets a new NameContext. The pNext field points to the
1235** NameContext in the parent query. Thus the process of scanning the
1236** NameContext list corresponds to searching through successively outer
1237** subqueries looking for a match.
1238*/
1239struct NameContext {
1240 Parse *pParse; /* The parser */
1241 SrcList *pSrcList; /* One or more tables used to resolve names */
1242 ExprList *pEList; /* Optional list of named expressions */
1243 int nRef; /* Number of names resolved by this context */
1244 int nErr; /* Number of errors encountered while resolving names */
1245 u8 allowAgg; /* Aggregate functions allowed here */
drh13449892005-09-07 21:22:45 +00001246 u8 hasAgg; /* True if aggregates are seen */
drh06f65412005-11-03 02:03:13 +00001247 u8 isCheck; /* True if resolving names in a CHECK constraint */
danielk1977b3bce662005-01-29 08:32:43 +00001248 int nDepth; /* Depth of subquery recursion. 1 for no recursion */
drh13449892005-09-07 21:22:45 +00001249 AggInfo *pAggInfo; /* Information about aggregates at this level */
danielk1977b3bce662005-01-29 08:32:43 +00001250 NameContext *pNext; /* Next outer name context. NULL for outermost */
1251};
1252
1253/*
drh9bb61fe2000-06-05 16:01:39 +00001254** An instance of the following structure contains all information
1255** needed to generate code for a single SELECT statement.
drha76b5df2002-02-23 02:32:10 +00001256**
drhd11d3822002-06-21 23:01:49 +00001257** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0.
1258** If there is a LIMIT clause, the parser sets nLimit to the value of the
1259** limit and nOffset to the value of the offset (or 0 if there is not
1260** offset). But later on, nLimit and nOffset become the memory locations
1261** in the VDBE that record the limit and offset counters.
drh0342b1f2005-09-01 03:07:44 +00001262**
drhb9bb7c12006-06-11 23:41:55 +00001263** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
drh0342b1f2005-09-01 03:07:44 +00001264** These addresses must be stored so that we can go back and fill in
1265** the P3_KEYINFO and P2 parameters later. Neither the KeyInfo nor
1266** the number of columns in P2 can be computed at the same time
drhb9bb7c12006-06-11 23:41:55 +00001267** as the OP_OpenEphm instruction is coded because not
drh0342b1f2005-09-01 03:07:44 +00001268** enough information about the compound query is known at that point.
drhb9bb7c12006-06-11 23:41:55 +00001269** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
1270** for the result set. The KeyInfo for addrOpenTran[2] contains collating
drh0342b1f2005-09-01 03:07:44 +00001271** sequences for the ORDER BY clause.
drh9bb61fe2000-06-05 16:01:39 +00001272*/
1273struct Select {
drh9bb61fe2000-06-05 16:01:39 +00001274 ExprList *pEList; /* The fields of the result */
drh7b58dae2003-07-20 01:16:46 +00001275 u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
1276 u8 isDistinct; /* True if the DISTINCT keyword is present */
drh0342b1f2005-09-01 03:07:44 +00001277 u8 isResolved; /* True once sqlite3SelectResolve() has run. */
1278 u8 isAgg; /* True if this is an aggregate query */
drhb9bb7c12006-06-11 23:41:55 +00001279 u8 usesEphm; /* True if uses an OpenEphemeral opcode */
drh4b14b4d2005-09-19 17:35:53 +00001280 u8 disallowOrderBy; /* Do not allow an ORDER BY to be attached if TRUE */
drh6c1426f2007-04-12 03:54:38 +00001281 char affinity; /* MakeRecord with this affinity for SRT_Set */
drhad3cab52002-05-24 02:04:32 +00001282 SrcList *pSrc; /* The FROM clause */
drh9bb61fe2000-06-05 16:01:39 +00001283 Expr *pWhere; /* The WHERE clause */
1284 ExprList *pGroupBy; /* The GROUP BY clause */
1285 Expr *pHaving; /* The HAVING clause */
1286 ExprList *pOrderBy; /* The ORDER BY clause */
drh967e8b72000-06-21 13:59:10 +00001287 Select *pPrior; /* Prior select in a compound select statement */
drh0342b1f2005-09-01 03:07:44 +00001288 Select *pRightmost; /* Right-most select in a compound select statement */
danielk1977a2dc3b12005-02-05 12:48:48 +00001289 Expr *pLimit; /* LIMIT expression. NULL means not used. */
1290 Expr *pOffset; /* OFFSET expression. NULL means not used. */
drh7b58dae2003-07-20 01:16:46 +00001291 int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */
drhb9bb7c12006-06-11 23:41:55 +00001292 int addrOpenEphm[3]; /* OP_OpenEphem opcodes related to this select */
drh9bb61fe2000-06-05 16:01:39 +00001293};
1294
1295/*
drhfef52082000-06-06 01:50:43 +00001296** The results of a select can be distributed in several ways.
1297*/
drh13449892005-09-07 21:22:45 +00001298#define SRT_Union 1 /* Store result as keys in an index */
1299#define SRT_Except 2 /* Remove result from a UNION index */
1300#define SRT_Discard 3 /* Do not save the results anywhere */
drhfef52082000-06-06 01:50:43 +00001301
drh13449892005-09-07 21:22:45 +00001302/* The ORDER BY clause is ignored for all of the above */
1303#define IgnorableOrderby(X) (X<=SRT_Discard)
1304
1305#define SRT_Callback 4 /* Invoke a callback with each row of result */
1306#define SRT_Mem 5 /* Store result in a memory cell */
1307#define SRT_Set 6 /* Store non-null results as keys in an index */
drhd49c16e2005-09-08 02:00:25 +00001308#define SRT_Table 7 /* Store result as data with an automatic rowid */
drhb9bb7c12006-06-11 23:41:55 +00001309#define SRT_EphemTab 8 /* Create transient tab and store like SRT_Table */
drh9d2985c2005-09-08 01:58:42 +00001310#define SRT_Subroutine 9 /* Call a subroutine to handle results */
drhec7429a2005-10-06 16:53:14 +00001311#define SRT_Exists 10 /* Store 1 if the result is not empty */
drh22827922000-06-06 17:27:05 +00001312
1313/*
drhf57b3392001-10-08 13:22:32 +00001314** An SQL parser context. A copy of this structure is passed through
1315** the parser and down into all the parser action routine in order to
1316** carry around information that is global to the entire parse.
drhf1974842004-11-05 03:56:00 +00001317**
1318** The structure is divided into two parts. When the parser and code
1319** generate call themselves recursively, the first part of the structure
1320** is constant but the second part is reset at the beginning and end of
1321** each recursion.
danielk1977c00da102006-01-07 13:21:04 +00001322**
1323** The nTableLock and aTableLock variables are only used if the shared-cache
1324** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
1325** used to store the set of table-locks required by the statement being
1326** compiled. Function sqlite3TableLock() is used to add entries to the
1327** list.
drh75897232000-05-29 14:26:00 +00001328*/
1329struct Parse {
drh9bb575f2004-09-06 17:24:11 +00001330 sqlite3 *db; /* The main database structure */
drh4c504392000-10-16 22:06:40 +00001331 int rc; /* Return code from execution */
drh75897232000-05-29 14:26:00 +00001332 char *zErrMsg; /* An error message */
drh75897232000-05-29 14:26:00 +00001333 Vdbe *pVdbe; /* An engine for executing database bytecode */
drh836faa42003-01-11 13:30:57 +00001334 u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */
drhe0bc4042002-06-25 01:09:11 +00001335 u8 nameClash; /* A permanent table name clashes with temp table name */
drha6ecd332004-06-10 00:29:09 +00001336 u8 checkSchema; /* Causes schema cookie check after an error */
drh205f48e2004-11-05 00:43:11 +00001337 u8 nested; /* Number of nested calls to the parser/code generator */
drh7e326c02007-05-15 16:51:37 +00001338 u8 parseError; /* True after a parsing error. Ticket #1794 */
drh75897232000-05-29 14:26:00 +00001339 int nErr; /* Number of errors seen */
drh832508b2002-03-02 17:04:07 +00001340 int nTab; /* Number of previously allocated VDBE cursors */
drh19a775c2000-06-05 18:54:46 +00001341 int nMem; /* Number of memory cells used so far */
drhfef52082000-06-06 01:50:43 +00001342 int nSet; /* Number of sets used so far */
drhffe07b22005-11-03 00:41:17 +00001343 int ckOffset; /* Stack offset to data used by CHECK constraints */
drh80242052004-06-09 00:48:12 +00001344 u32 writeMask; /* Start a write transaction on these databases */
drhfcd35c72005-05-21 02:48:08 +00001345 u32 cookieMask; /* Bitmask of schema verified databases */
1346 int cookieGoto; /* Address of OP_Goto to cookie verifier subroutine */
drhc797d4d2007-05-08 01:08:49 +00001347 int cookieValue[SQLITE_MAX_ATTACHED+2]; /* Values of cookies to verify */
danielk1977c00da102006-01-07 13:21:04 +00001348#ifndef SQLITE_OMIT_SHARED_CACHE
1349 int nTableLock; /* Number of locks in aTableLock */
1350 TableLock *aTableLock; /* Required table locks for shared-cache mode */
1351#endif
drhf1974842004-11-05 03:56:00 +00001352
1353 /* Above is constant between recursions. Below is reset before and after
1354 ** each recursion */
1355
1356 int nVar; /* Number of '?' variables seen in the SQL so far */
1357 int nVarExpr; /* Number of used slots in apVarExpr[] */
1358 int nVarExprAlloc; /* Number of allocated slots in apVarExpr[] */
1359 Expr **apVarExpr; /* Pointers to :aaa and $aaaa wildcard expressions */
1360 u8 explain; /* True if the EXPLAIN flag is found on the query */
drhf1974842004-11-05 03:56:00 +00001361 Token sErrToken; /* The token at which the error occurred */
1362 Token sNameToken; /* Token with unqualified schema object name */
1363 Token sLastToken; /* The last token parsed */
1364 const char *zSql; /* All SQL text */
1365 const char *zTail; /* All SQL text past the last semicolon parsed */
1366 Table *pNewTable; /* A table being constructed by CREATE TABLE */
1367 Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */
1368 TriggerStack *trigStack; /* Trigger actions being coded */
1369 const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
drhb9bb7c12006-06-11 23:41:55 +00001370#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk197733b39332006-06-24 08:51:05 +00001371 Token sArg; /* Complete text of a module argument */
danielk1977f9e7dda2006-06-16 16:08:53 +00001372 u8 declareVtab; /* True if inside sqlite3_declare_vtab() */
1373 Table *pVirtualLock; /* Require virtual table lock on this table */
drhb9bb7c12006-06-11 23:41:55 +00001374#endif
danielk1977e6a58a42007-08-31 17:42:48 +00001375#if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
danielk1977fc976062007-05-10 10:46:56 +00001376 int nHeight; /* Expression tree height of current sub-select */
1377#endif
drh75897232000-05-29 14:26:00 +00001378};
1379
danielk19777e6ebfb2006-06-12 11:24:37 +00001380#ifdef SQLITE_OMIT_VIRTUALTABLE
1381 #define IN_DECLARE_VTAB 0
1382#else
1383 #define IN_DECLARE_VTAB (pParse->declareVtab)
1384#endif
1385
danielk1977d99bc932002-05-16 00:13:12 +00001386/*
drh85e20962003-04-25 17:52:11 +00001387** An instance of the following structure can be declared on a stack and used
1388** to save the Parse.zAuthContext value so that it can be restored later.
1389*/
1390struct AuthContext {
1391 const char *zAuthContext; /* Put saved Parse.zAuthContext here */
1392 Parse *pParse; /* The Parse structure */
1393};
1394
1395/*
drhf0863fe2005-06-12 21:35:51 +00001396** Bitfield flags for P2 value in OP_Insert and OP_Delete
rdcb0c374f2004-02-20 22:53:38 +00001397*/
1398#define OPFLAG_NCHANGE 1 /* Set to update db->nChange */
1399#define OPFLAG_LASTROWID 2 /* Set to update db->lastRowid */
danielk197794eb6a12005-12-15 15:22:08 +00001400#define OPFLAG_ISUPDATE 4 /* This OP_Insert is an sql UPDATE */
drhe4d90812007-03-29 05:51:49 +00001401#define OPFLAG_APPEND 8 /* This is likely to be an append */
rdcb0c374f2004-02-20 22:53:38 +00001402
1403/*
danielk1977d99bc932002-05-16 00:13:12 +00001404 * Each trigger present in the database schema is stored as an instance of
1405 * struct Trigger.
1406 *
1407 * Pointers to instances of struct Trigger are stored in two ways.
drh9bb575f2004-09-06 17:24:11 +00001408 * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
danielk1977d99bc932002-05-16 00:13:12 +00001409 * database). This allows Trigger structures to be retrieved by name.
1410 * 2. All triggers associated with a single table form a linked list, using the
drhad3cab52002-05-24 02:04:32 +00001411 * pNext member of struct Trigger. A pointer to the first element of the
1412 * linked list is stored as the "pTrigger" member of the associated
1413 * struct Table.
danielk1977d99bc932002-05-16 00:13:12 +00001414 *
drhad3cab52002-05-24 02:04:32 +00001415 * The "step_list" member points to the first element of a linked list
1416 * containing the SQL statements specified as the trigger program.
danielk1977d99bc932002-05-16 00:13:12 +00001417 */
danielk1977c3f9bad2002-05-15 08:30:12 +00001418struct Trigger {
drhdc379452002-05-15 12:45:43 +00001419 char *name; /* The name of the trigger */
1420 char *table; /* The table or view to which the trigger applies */
drhf0f258b2003-04-21 18:48:45 +00001421 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */
drhdca76842004-12-07 14:06:13 +00001422 u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
drhdc379452002-05-15 12:45:43 +00001423 Expr *pWhen; /* The WHEN clause of the expresion (may be NULL) */
1424 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger,
danielk1977d99bc932002-05-16 00:13:12 +00001425 the <column-list> is stored here */
drh4312db52003-06-03 01:47:11 +00001426 Token nameToken; /* Token containing zName. Use during parsing only */
danielk1977e501b892006-01-09 06:29:47 +00001427 Schema *pSchema; /* Schema containing the trigger */
1428 Schema *pTabSchema; /* Schema containing the table */
drhdc379452002-05-15 12:45:43 +00001429 TriggerStep *step_list; /* Link list of trigger program steps */
drhdc379452002-05-15 12:45:43 +00001430 Trigger *pNext; /* Next trigger associated with the table */
danielk1977c3f9bad2002-05-15 08:30:12 +00001431};
1432
danielk1977d99bc932002-05-16 00:13:12 +00001433/*
drhdca76842004-12-07 14:06:13 +00001434** A trigger is either a BEFORE or an AFTER trigger. The following constants
1435** determine which.
1436**
1437** If there are multiple triggers, you might of some BEFORE and some AFTER.
1438** In that cases, the constants below can be ORed together.
1439*/
1440#define TRIGGER_BEFORE 1
1441#define TRIGGER_AFTER 2
1442
1443/*
danielk1977d99bc932002-05-16 00:13:12 +00001444 * An instance of struct TriggerStep is used to store a single SQL statement
1445 * that is a part of a trigger-program.
1446 *
1447 * Instances of struct TriggerStep are stored in a singly linked list (linked
1448 * using the "pNext" member) referenced by the "step_list" member of the
1449 * associated struct Trigger instance. The first element of the linked list is
1450 * the first step of the trigger-program.
1451 *
1452 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
1453 * "SELECT" statement. The meanings of the other members is determined by the
1454 * value of "op" as follows:
1455 *
1456 * (op == TK_INSERT)
1457 * orconf -> stores the ON CONFLICT algorithm
1458 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then
1459 * this stores a pointer to the SELECT statement. Otherwise NULL.
1460 * target -> A token holding the name of the table to insert into.
1461 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
1462 * this stores values to be inserted. Otherwise NULL.
1463 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ...
drhad3cab52002-05-24 02:04:32 +00001464 * statement, then this stores the column-names to be
1465 * inserted into.
danielk1977d99bc932002-05-16 00:13:12 +00001466 *
1467 * (op == TK_DELETE)
1468 * target -> A token holding the name of the table to delete from.
1469 * pWhere -> The WHERE clause of the DELETE statement if one is specified.
1470 * Otherwise NULL.
1471 *
1472 * (op == TK_UPDATE)
1473 * target -> A token holding the name of the table to update rows of.
1474 * pWhere -> The WHERE clause of the UPDATE statement if one is specified.
1475 * Otherwise NULL.
1476 * pExprList -> A list of the columns to update and the expressions to update
danielk19774adee202004-05-08 08:23:19 +00001477 * them to. See sqlite3Update() documentation of "pChanges"
drhad3cab52002-05-24 02:04:32 +00001478 * argument.
danielk1977d99bc932002-05-16 00:13:12 +00001479 *
1480 */
1481struct TriggerStep {
1482 int op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1483 int orconf; /* OE_Rollback etc. */
drha69d9162003-04-17 22:57:53 +00001484 Trigger *pTrig; /* The trigger that this step is a part of */
danielk1977c3f9bad2002-05-15 08:30:12 +00001485
danielk1977d99bc932002-05-16 00:13:12 +00001486 Select *pSelect; /* Valid for SELECT and sometimes
drhfd131da2007-08-07 17:13:03 +00001487 INSERT steps (when pExprList == 0) */
danielk1977d99bc932002-05-16 00:13:12 +00001488 Token target; /* Valid for DELETE, UPDATE, INSERT steps */
1489 Expr *pWhere; /* Valid for DELETE, UPDATE steps */
1490 ExprList *pExprList; /* Valid for UPDATE statements and sometimes
drhfd131da2007-08-07 17:13:03 +00001491 INSERT steps (when pSelect == 0) */
danielk1977d99bc932002-05-16 00:13:12 +00001492 IdList *pIdList; /* Valid for INSERT statements only */
drh187e4c62006-02-27 22:22:27 +00001493 TriggerStep *pNext; /* Next in the link-list */
1494 TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */
danielk1977d99bc932002-05-16 00:13:12 +00001495};
1496
1497/*
1498 * An instance of struct TriggerStack stores information required during code
1499 * generation of a single trigger program. While the trigger program is being
1500 * coded, its associated TriggerStack instance is pointed to by the
1501 * "pTriggerStack" member of the Parse structure.
1502 *
1503 * The pTab member points to the table that triggers are being coded on. The
1504 * newIdx member contains the index of the vdbe cursor that points at the temp
1505 * table that stores the new.* references. If new.* references are not valid
1506 * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1507 * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1508 *
1509 * The ON CONFLICT policy to be used for the trigger program steps is stored
1510 * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1511 * specified for individual triggers steps is used.
1512 *
1513 * struct TriggerStack has a "pNext" member, to allow linked lists to be
1514 * constructed. When coding nested triggers (triggers fired by other triggers)
1515 * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1516 * pointer. Once the nested trigger has been coded, the pNext value is restored
1517 * to the pTriggerStack member of the Parse stucture and coding of the parent
1518 * trigger continues.
1519 *
1520 * Before a nested trigger is coded, the linked list pointed to by the
1521 * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1522 * recursively. If this condition is detected, the nested trigger is not coded.
1523 */
1524struct TriggerStack {
1525 Table *pTab; /* Table that triggers are currently being coded on */
1526 int newIdx; /* Index of vdbe cursor to "new" temp table */
1527 int oldIdx; /* Index of vdbe cursor to "old" temp table */
1528 int orconf; /* Current orconf policy */
danielk19776f349032002-06-11 02:25:40 +00001529 int ignoreJump; /* where to jump to for a RAISE(IGNORE) */
drhe22a3342003-04-22 20:30:37 +00001530 Trigger *pTrigger; /* The trigger currently being coded */
1531 TriggerStack *pNext; /* Next trigger down on the trigger stack */
danielk1977d99bc932002-05-16 00:13:12 +00001532};
1533
1534/*
drhf26e09c2003-05-31 16:21:12 +00001535** The following structure contains information used by the sqliteFix...
1536** routines as they walk the parse tree to make database references
1537** explicit.
1538*/
1539typedef struct DbFixer DbFixer;
1540struct DbFixer {
1541 Parse *pParse; /* The parsing context. Error messages written here */
1542 const char *zDb; /* Make sure all objects are contained in this database */
1543 const char *zType; /* Type of the container - used for error messages */
1544 const Token *pName; /* Name of the container - used for error messages */
1545};
1546
1547/*
drh234c39d2004-07-24 03:30:47 +00001548** A pointer to this structure is used to communicate information
1549** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
1550*/
1551typedef struct {
drh9bb575f2004-09-06 17:24:11 +00001552 sqlite3 *db; /* The database being initialized */
drhece3c722006-09-23 20:36:01 +00001553 int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */
drh234c39d2004-07-24 03:30:47 +00001554 char **pzErrMsg; /* Error message stored here */
drh15ca1df2006-07-26 13:43:30 +00001555 int rc; /* Result code stored here */
drh234c39d2004-07-24 03:30:47 +00001556} InitData;
1557
drhb6c29892004-11-22 19:12:19 +00001558/*
drh66150952007-07-23 19:12:41 +00001559** Assuming zIn points to the first byte of a UTF-8 character,
1560** advance zIn to point to the first byte of the next UTF-8 character.
drh4a919112007-05-15 11:55:09 +00001561*/
drh4a919112007-05-15 11:55:09 +00001562#define SQLITE_SKIP_UTF8(zIn) { \
1563 if( (*(zIn++))>=0xc0 ){ \
1564 while( (*zIn & 0xc0)==0x80 ){ zIn++; } \
1565 } \
1566}
1567
drh4a919112007-05-15 11:55:09 +00001568/*
drh49285702005-09-17 15:20:26 +00001569** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production
1570** builds) or a function call (for debugging). If it is a function call,
1571** it allows the operator to set a breakpoint at the spot where database
1572** corruption is first detected.
1573*/
1574#ifdef SQLITE_DEBUG
drh6e736832007-05-11 12:30:03 +00001575 int sqlite3Corrupt(void);
drh49285702005-09-17 15:20:26 +00001576# define SQLITE_CORRUPT_BKPT sqlite3Corrupt()
1577#else
1578# define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT
1579#endif
1580
1581/*
drh75897232000-05-29 14:26:00 +00001582** Internal function prototypes
1583*/
danielk19774adee202004-05-08 08:23:19 +00001584int sqlite3StrICmp(const char *, const char *);
1585int sqlite3StrNICmp(const char *, const char *, int);
danielk19778a6b5412004-05-24 07:04:25 +00001586int sqlite3IsNumber(const char*, int*, u8);
danielk19772e588c72005-12-09 14:25:08 +00001587
drh17435752007-08-16 04:30:38 +00001588void *sqlite3MallocZero(unsigned);
1589void *sqlite3DbMallocZero(sqlite3*, unsigned);
1590void *sqlite3DbMallocRaw(sqlite3*, unsigned);
danielk19772e588c72005-12-09 14:25:08 +00001591char *sqlite3StrDup(const char*);
1592char *sqlite3StrNDup(const char*, int);
drh17435752007-08-16 04:30:38 +00001593char *sqlite3DbStrDup(sqlite3*,const char*);
1594char *sqlite3DbStrNDup(sqlite3*,const char*, int);
drh97c8ec32007-08-27 21:49:34 +00001595void *sqlite3DbReallocOrFree(sqlite3 *, void *, int);
danielk1977a1644fd2007-08-29 12:31:25 +00001596void *sqlite3DbRealloc(sqlite3 *, void *, int);
danielk19772e588c72005-12-09 14:25:08 +00001597
drh17435752007-08-16 04:30:38 +00001598char *sqlite3MPrintf(sqlite3*,const char*, ...);
1599char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
drh87cc3b32007-05-08 21:45:27 +00001600#if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
1601 void sqlite3DebugPrintf(const char*, ...);
1602 void *sqlite3TextToPtr(const char*);
1603#endif
drh41f58522005-06-06 15:06:39 +00001604void sqlite3SetString(char **, ...);
danielk19774adee202004-05-08 08:23:19 +00001605void sqlite3ErrorMsg(Parse*, const char*, ...);
drha0733842005-12-29 01:11:36 +00001606void sqlite3ErrorClear(Parse*);
danielk19774adee202004-05-08 08:23:19 +00001607void sqlite3Dequote(char*);
drh17435752007-08-16 04:30:38 +00001608void sqlite3DequoteExpr(sqlite3*, Expr*);
drh2646da72005-12-09 20:02:05 +00001609int sqlite3KeywordCode(const unsigned char*, int);
danielk19774adee202004-05-08 08:23:19 +00001610int sqlite3RunParser(Parse*, const char*, char **);
drh80242052004-06-09 00:48:12 +00001611void sqlite3FinishCoding(Parse*);
danielk1977a1644fd2007-08-29 12:31:25 +00001612Expr *sqlite3Expr(sqlite3*, int, Expr*, Expr*, const Token*);
drh17435752007-08-16 04:30:38 +00001613Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*);
drh4e0cff62004-11-05 05:10:28 +00001614Expr *sqlite3RegisterExpr(Parse*,Token*);
danielk19771e536952007-08-16 10:09:01 +00001615Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
danielk19774adee202004-05-08 08:23:19 +00001616void sqlite3ExprSpan(Expr*,Token*,Token*);
drh17435752007-08-16 04:30:38 +00001617Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
drhfa6bc002004-09-07 16:19:52 +00001618void sqlite3ExprAssignVarNumber(Parse*, Expr*);
danielk19774adee202004-05-08 08:23:19 +00001619void sqlite3ExprDelete(Expr*);
drh17435752007-08-16 04:30:38 +00001620ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*,Token*);
danielk19774adee202004-05-08 08:23:19 +00001621void sqlite3ExprListDelete(ExprList*);
drh9bb575f2004-09-06 17:24:11 +00001622int sqlite3Init(sqlite3*, char**);
drh234c39d2004-07-24 03:30:47 +00001623int sqlite3InitCallback(void*, int, char**, char**);
danielk197791cf71b2004-06-26 06:37:06 +00001624void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
drh9bb575f2004-09-06 17:24:11 +00001625void sqlite3ResetInternalSchema(sqlite3*, int);
danielk19774adee202004-05-08 08:23:19 +00001626void sqlite3BeginParse(Parse*,int);
drh9bb575f2004-09-06 17:24:11 +00001627void sqlite3CommitInternalChanges(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00001628Table *sqlite3ResultSetOfSelect(Parse*,char*,Select*);
danielk1977c00da102006-01-07 13:21:04 +00001629void sqlite3OpenMasterTable(Parse *, int);
danielk1977f1a381e2006-06-16 08:01:02 +00001630void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
danielk19774adee202004-05-08 08:23:19 +00001631void sqlite3AddColumn(Parse*,Token*);
1632void sqlite3AddNotNull(Parse*, int);
drhfdd6e852005-12-16 01:06:16 +00001633void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
drhffe07b22005-11-03 00:41:17 +00001634void sqlite3AddCheckConstraint(Parse*, Expr*);
drh487e2622005-06-25 18:42:14 +00001635void sqlite3AddColumnType(Parse*,Token*);
danielk19777977a172004-11-09 12:44:37 +00001636void sqlite3AddDefaultValue(Parse*,Expr*);
drhd3d39e92004-05-20 22:16:29 +00001637void sqlite3AddCollateType(Parse*, const char*, int);
danielk197719a8e7e2005-03-17 05:03:38 +00001638void sqlite3EndTable(Parse*,Token*,Token*,Select*);
drhb7f91642004-10-31 02:22:47 +00001639
drhfdd48a72006-09-11 23:45:48 +00001640void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int);
danielk1977fe3fcbe22006-06-12 12:08:45 +00001641
1642#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
drhb7f91642004-10-31 02:22:47 +00001643 int sqlite3ViewGetColumnNames(Parse*,Table*);
1644#else
1645# define sqlite3ViewGetColumnNames(A,B) 0
1646#endif
1647
drha0733842005-12-29 01:11:36 +00001648void sqlite3DropTable(Parse*, SrcList*, int, int);
danielk1977a04a34f2007-04-16 15:06:25 +00001649void sqlite3DeleteTable(Table*);
danielk19774adee202004-05-08 08:23:19 +00001650void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
drh17435752007-08-16 04:30:38 +00001651void *sqlite3ArrayAllocate(sqlite3*,void*,int,int,int*,int*,int*);
1652IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
danielk19774adee202004-05-08 08:23:19 +00001653int sqlite3IdListIndex(IdList*,const char*);
drh17435752007-08-16 04:30:38 +00001654SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
1655SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*, Token*,
drh61dfc312006-12-16 16:25:15 +00001656 Select*, Expr*, IdList*);
1657void sqlite3SrcListShiftJoinType(SrcList*);
danielk19774adee202004-05-08 08:23:19 +00001658void sqlite3SrcListAssignCursors(Parse*, SrcList*);
1659void sqlite3IdListDelete(IdList*);
1660void sqlite3SrcListDelete(SrcList*);
danielk19770202b292004-06-09 09:55:16 +00001661void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
drh4d91a702006-01-04 15:54:36 +00001662 Token*, int, int);
1663void sqlite3DropIndex(Parse*, SrcList*, int);
danielk1977b3bce662005-01-29 08:32:43 +00001664int sqlite3Select(Parse*, Select*, int, int, Select*, int, int*, char *aff);
drh17435752007-08-16 04:30:38 +00001665Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
1666 Expr*,ExprList*,int,Expr*,Expr*);
danielk19774adee202004-05-08 08:23:19 +00001667void sqlite3SelectDelete(Select*);
danielk19774adee202004-05-08 08:23:19 +00001668Table *sqlite3SrcListLookup(Parse*, SrcList*);
1669int sqlite3IsReadOnly(Parse*, Table*, int);
danielk1977c00da102006-01-07 13:21:04 +00001670void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
danielk19774adee202004-05-08 08:23:19 +00001671void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
1672void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
drhf8db1bc2005-04-22 02:38:37 +00001673WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**);
danielk19774adee202004-05-08 08:23:19 +00001674void sqlite3WhereEnd(WhereInfo*);
drh945498f2007-02-24 11:52:52 +00001675void sqlite3ExprCodeGetColumn(Vdbe*, Table*, int, int);
danielk19774adee202004-05-08 08:23:19 +00001676void sqlite3ExprCode(Parse*, Expr*);
drh25303782004-12-07 15:41:48 +00001677void sqlite3ExprCodeAndCache(Parse*, Expr*);
drhf9b596e2004-05-26 16:54:42 +00001678int sqlite3ExprCodeExprList(Parse*, ExprList*);
danielk19774adee202004-05-08 08:23:19 +00001679void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
1680void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
drh9bb575f2004-09-06 17:24:11 +00001681Table *sqlite3FindTable(sqlite3*,const char*, const char*);
danielk19774adee202004-05-08 08:23:19 +00001682Table *sqlite3LocateTable(Parse*,const char*, const char*);
drh9bb575f2004-09-06 17:24:11 +00001683Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
1684void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
1685void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
drh74161702006-02-24 02:53:49 +00001686void sqlite3Vacuum(Parse*);
drh9bb575f2004-09-06 17:24:11 +00001687int sqlite3RunVacuum(char**, sqlite3*);
drh17435752007-08-16 04:30:38 +00001688char *sqlite3NameFromToken(sqlite3*, Token*);
danielk19774adee202004-05-08 08:23:19 +00001689int sqlite3ExprCompare(Expr*, Expr*);
danielk1977b3bce662005-01-29 08:32:43 +00001690int sqlite3ExprResolveNames(NameContext *, Expr *);
danielk1977a58fdfb2005-02-08 07:50:40 +00001691int sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
drh5d9a4af2005-08-30 00:54:01 +00001692int sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
danielk19774adee202004-05-08 08:23:19 +00001693Vdbe *sqlite3GetVdbe(Parse*);
danielk19771e536952007-08-16 10:09:01 +00001694Expr *sqlite3CreateIdExpr(Parse *, const char*);
danielk19774adee202004-05-08 08:23:19 +00001695void sqlite3Randomness(int, void*);
drh9bb575f2004-09-06 17:24:11 +00001696void sqlite3RollbackAll(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00001697void sqlite3CodeVerifySchema(Parse*, int);
drh684917c2004-10-05 02:41:42 +00001698void sqlite3BeginTransaction(Parse*, int);
danielk19774adee202004-05-08 08:23:19 +00001699void sqlite3CommitTransaction(Parse*);
1700void sqlite3RollbackTransaction(Parse*);
1701int sqlite3ExprIsConstant(Expr*);
drh0a168372007-06-08 00:20:47 +00001702int sqlite3ExprIsConstantNotJoin(Expr*);
drheb55bd22005-06-30 17:04:21 +00001703int sqlite3ExprIsConstantOrFunction(Expr*);
danielk19774adee202004-05-08 08:23:19 +00001704int sqlite3ExprIsInteger(Expr*, int*);
1705int sqlite3IsRowid(const char*);
drh9bb575f2004-09-06 17:24:11 +00001706void sqlite3GenerateRowDelete(sqlite3*, Vdbe*, Table*, int, int);
drh74161702006-02-24 02:53:49 +00001707void sqlite3GenerateRowIndexDelete(Vdbe*, Table*, int, char*);
drh51846b52004-05-28 16:00:21 +00001708void sqlite3GenerateIndexKey(Vdbe*, Index*, int);
danielk19774adee202004-05-08 08:23:19 +00001709void sqlite3GenerateConstraintChecks(Parse*,Table*,int,char*,int,int,int,int);
drhe4d90812007-03-29 05:51:49 +00001710void sqlite3CompleteInsertion(Parse*, Table*, int, char*, int, int, int, int);
drh290c1942004-08-21 17:54:45 +00001711void sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
danielk19774adee202004-05-08 08:23:19 +00001712void sqlite3BeginWriteOperation(Parse*, int, int);
drh17435752007-08-16 04:30:38 +00001713Expr *sqlite3ExprDup(sqlite3*,Expr*);
1714void sqlite3TokenCopy(sqlite3*,Token*, Token*);
1715ExprList *sqlite3ExprListDup(sqlite3*,ExprList*);
1716SrcList *sqlite3SrcListDup(sqlite3*,SrcList*);
1717IdList *sqlite3IdListDup(sqlite3*,IdList*);
1718Select *sqlite3SelectDup(sqlite3*,Select*);
drh9bb575f2004-09-06 17:24:11 +00001719FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
1720void sqlite3RegisterBuiltinFunctions(sqlite3*);
1721void sqlite3RegisterDateTimeFunctions(sqlite3*);
1722int sqlite3SafetyOn(sqlite3*);
1723int sqlite3SafetyOff(sqlite3*);
1724int sqlite3SafetyCheck(sqlite3*);
1725void sqlite3ChangeCookie(sqlite3*, Vdbe*, int);
drhb7f91642004-10-31 02:22:47 +00001726
1727#ifndef SQLITE_OMIT_TRIGGER
1728 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
drh60218d22007-04-06 11:26:00 +00001729 Expr*,int, int);
drhb7f91642004-10-31 02:22:47 +00001730 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
drhfdd48a72006-09-11 23:45:48 +00001731 void sqlite3DropTrigger(Parse*, SrcList*, int);
drh74161702006-02-24 02:53:49 +00001732 void sqlite3DropTriggerPtr(Parse*, Trigger*);
drhdca76842004-12-07 14:06:13 +00001733 int sqlite3TriggersExist(Parse*, Table*, int, ExprList*);
drhb7f91642004-10-31 02:22:47 +00001734 int sqlite3CodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
1735 int, int);
1736 void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
1737 void sqlite3DeleteTriggerStep(TriggerStep*);
drh17435752007-08-16 04:30:38 +00001738 TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*);
1739 TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
1740 ExprList*,Select*,int);
1741 TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, int);
1742 TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*);
drhb7f91642004-10-31 02:22:47 +00001743 void sqlite3DeleteTrigger(Trigger*);
1744 void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
1745#else
1746# define sqlite3TriggersExist(A,B,C,D,E,F) 0
1747# define sqlite3DeleteTrigger(A)
drhcdd536f2006-03-17 00:04:03 +00001748# define sqlite3DropTriggerPtr(A,B)
drhb7f91642004-10-31 02:22:47 +00001749# define sqlite3UnlinkAndDeleteTrigger(A,B,C)
1750# define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I) 0
1751#endif
1752
danielk19774adee202004-05-08 08:23:19 +00001753int sqlite3JoinType(Parse*, Token*, Token*, Token*);
danielk19770202b292004-06-09 09:55:16 +00001754void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
danielk19774adee202004-05-08 08:23:19 +00001755void sqlite3DeferForeignKey(Parse*, int);
drhed6c8672003-01-12 18:02:16 +00001756#ifndef SQLITE_OMIT_AUTHORIZATION
drh728b5772007-09-18 15:55:07 +00001757 void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
danielk19774adee202004-05-08 08:23:19 +00001758 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
1759 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
1760 void sqlite3AuthContextPop(AuthContext*);
drhed6c8672003-01-12 18:02:16 +00001761#else
danielk19774adee202004-05-08 08:23:19 +00001762# define sqlite3AuthRead(a,b,c)
1763# define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK
1764# define sqlite3AuthContextPush(a,b,c)
1765# define sqlite3AuthContextPop(a) ((void)(a))
drhed6c8672003-01-12 18:02:16 +00001766#endif
danielk1977f744bb52005-12-06 17:19:11 +00001767void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
1768void sqlite3Detach(Parse*, Expr*);
drh9bb575f2004-09-06 17:24:11 +00001769int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
drh33f4e022007-09-03 15:19:34 +00001770 int omitJournal, int nCache, int flags, Btree **ppBtree);
danielk19774adee202004-05-08 08:23:19 +00001771int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
1772int sqlite3FixSrcList(DbFixer*, SrcList*);
1773int sqlite3FixSelect(DbFixer*, Select*);
1774int sqlite3FixExpr(DbFixer*, Expr*);
1775int sqlite3FixExprList(DbFixer*, ExprList*);
1776int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
drh487e2622005-06-25 18:42:14 +00001777int sqlite3AtoF(const char *z, double*);
danielk19776f8a5032004-05-10 10:34:51 +00001778char *sqlite3_snprintf(int,char*,const char*,...);
drhfec19aa2004-05-19 20:41:03 +00001779int sqlite3GetInt32(const char *, int*);
drhfec19aa2004-05-19 20:41:03 +00001780int sqlite3FitsIn64Bits(const char *);
drhee858132007-05-08 20:37:38 +00001781int sqlite3Utf16ByteLen(const void *pData, int nChar);
1782int sqlite3Utf8CharLen(const char *pData, int nByte);
drh66150952007-07-23 19:12:41 +00001783int sqlite3Utf8Read(const u8*, const u8*, const u8**);
danielk1977192ac1d2004-05-10 07:17:30 +00001784int sqlite3PutVarint(unsigned char *, u64);
danielk197790e4d952004-05-10 10:05:53 +00001785int sqlite3GetVarint(const unsigned char *, u64 *);
drh6d2fb152004-05-14 16:50:06 +00001786int sqlite3GetVarint32(const unsigned char *, u32 *);
danielk1977192ac1d2004-05-10 07:17:30 +00001787int sqlite3VarintLen(u64 v);
danielk1977a37cdde2004-05-16 11:15:36 +00001788void sqlite3IndexAffinityStr(Vdbe *, Index *);
1789void sqlite3TableAffinityStr(Vdbe *, Table *);
danielk1977e014a832004-05-17 10:48:57 +00001790char sqlite3CompareAffinity(Expr *pExpr, char aff2);
danielk1977e014a832004-05-17 10:48:57 +00001791int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
danielk1977bf3b7212004-05-18 10:06:24 +00001792char sqlite3ExprAffinity(Expr *pExpr);
drhb6a9ece2007-06-26 00:37:27 +00001793int sqlite3Atoi64(const char*, i64*);
drh9bb575f2004-09-06 17:24:11 +00001794void sqlite3Error(sqlite3*, int, const char*,...);
danielk19771e536952007-08-16 10:09:01 +00001795void *sqlite3HexToBlob(sqlite3*, const char *z);
danielk1977ef2cb632004-05-29 02:37:19 +00001796int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
danielk1977f20b21c2004-05-31 23:56:42 +00001797const char *sqlite3ErrStr(int);
danielk19778a414492004-06-29 08:59:35 +00001798int sqlite3ReadSchema(Parse *pParse);
drh9bb575f2004-09-06 17:24:11 +00001799CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
danielk19770202b292004-06-09 09:55:16 +00001800CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
danielk19777cedc8d2004-06-10 10:50:08 +00001801CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
drh8b4c40d2007-02-01 23:02:45 +00001802Expr *sqlite3ExprSetColl(Parse *pParse, Expr *, Token *);
danielk19777cedc8d2004-06-10 10:50:08 +00001803int sqlite3CheckCollSeq(Parse *, CollSeq *);
danielk1977d8123362004-06-12 09:25:12 +00001804int sqlite3CheckObjectName(Parse *, const char *);
danielk1977b28af712004-06-21 06:50:26 +00001805void sqlite3VdbeSetChanges(sqlite3 *, int);
danielk19774e6af132004-06-10 14:01:08 +00001806
drhb21c8cd2007-08-21 19:33:56 +00001807const void *sqlite3ValueText(sqlite3_value*, u8);
1808int sqlite3ValueBytes(sqlite3_value*, u8);
1809void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
danielk19771e536952007-08-16 10:09:01 +00001810 void(*)(void*));
danielk19774e6af132004-06-10 14:01:08 +00001811void sqlite3ValueFree(sqlite3_value*);
danielk19771e536952007-08-16 10:09:01 +00001812sqlite3_value *sqlite3ValueNew(sqlite3 *);
1813char *sqlite3Utf16to8(sqlite3 *, const void*, int);
1814int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
drhb21c8cd2007-08-21 19:33:56 +00001815void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
drh46c99e02007-08-27 23:26:59 +00001816#ifndef SQLITE_AMALGAMATION
drh4e5ffc52004-08-31 00:52:37 +00001817extern const unsigned char sqlite3UpperToLower[];
drh46c99e02007-08-27 23:26:59 +00001818#endif
danielk1977a0bf2652004-11-04 14:30:04 +00001819void sqlite3RootPageMoved(Db*, int, int);
drh4343fea2004-11-05 23:46:15 +00001820void sqlite3Reindex(Parse*, Token*, Token*);
drh1f01ec12005-02-15 21:36:18 +00001821void sqlite3AlterFunctions(sqlite3*);
danielk19779fd2a9a2004-11-12 13:42:30 +00001822void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
1823int sqlite3GetToken(const unsigned char *, int *);
drh2958a4e2004-11-12 03:56:15 +00001824void sqlite3NestedParse(Parse*, const char*, ...);
drhd89bd002005-01-22 03:03:54 +00001825void sqlite3ExpirePreparedStatements(sqlite3*);
danielk1977b3bce662005-01-29 08:32:43 +00001826void sqlite3CodeSubselect(Parse *, Expr *);
1827int sqlite3SelectResolve(Parse *, Select *, NameContext *);
danielk1977aee18ef2005-03-09 12:26:50 +00001828void sqlite3ColumnDefault(Vdbe *, Table *, int);
danielk197719a8e7e2005-03-17 05:03:38 +00001829void sqlite3AlterFinishAddColumn(Parse *, Token *);
1830void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
danielk19774dade032005-05-25 10:45:10 +00001831CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int);
drh8a512562005-11-14 22:29:05 +00001832char sqlite3AffinityType(const Token*);
drh9f18e8a2005-07-08 12:13:04 +00001833void sqlite3Analyze(Parse*, Token*, Token*);
drha4afb652005-07-09 02:16:02 +00001834int sqlite3InvokeBusyHandler(BusyHandler*);
drhff2d5ea2005-07-23 00:41:48 +00001835int sqlite3FindDb(sqlite3*, Token*);
drhcf1be452007-05-12 12:08:51 +00001836int sqlite3AnalysisLoad(sqlite3*,int iDB);
drh51147ba2005-07-23 22:59:55 +00001837void sqlite3DefaultRowEst(Index*);
drh55ef4d92005-08-14 01:20:37 +00001838void sqlite3RegisterLikeFunctions(sqlite3*, int);
drhd64fe2f2005-08-28 17:00:23 +00001839int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
danielk1977f744bb52005-12-06 17:19:11 +00001840void sqlite3AttachFunctions(sqlite3 *);
drhfdd6e852005-12-16 01:06:16 +00001841void sqlite3MinimumFileFormat(Parse*, int, int);
danielk1977da184232006-01-05 11:34:32 +00001842void sqlite3SchemaFree(void *);
danielk19771e536952007-08-16 10:09:01 +00001843Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
danielk1977e501b892006-01-09 06:29:47 +00001844int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
danielk1977b3bf5562006-01-10 17:58:23 +00001845KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *);
danielk1977771151b2006-01-17 13:21:40 +00001846int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
1847 void (*)(sqlite3_context*,int,sqlite3_value **),
1848 void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*));
danielk197754f01982006-01-18 15:25:17 +00001849int sqlite3ApiExit(sqlite3 *db, int);
danielk19778d34dfd2006-01-24 16:37:57 +00001850void sqlite3AbortOtherActiveVdbes(sqlite3 *, Vdbe *);
danielk1977ddfb2f02006-02-17 12:25:14 +00001851int sqlite3OpenTempDatabase(Parse *);
drh69dab1d2006-06-27 14:37:20 +00001852
danielk19771e536952007-08-16 10:09:01 +00001853
drh95bdbbb2007-07-23 19:31:16 +00001854/*
1855** The interface to the LEMON-generated parser
1856*/
1857void *sqlite3ParserAlloc(void*(*)(size_t));
1858void sqlite3ParserFree(void*, void(*)(void*));
1859void sqlite3Parser(void*, int, Token, Parse*);
1860
drh69dab1d2006-06-27 14:37:20 +00001861#ifndef SQLITE_OMIT_LOAD_EXTENSION
1862 void sqlite3CloseExtensions(sqlite3*);
drh1409be62006-08-23 20:07:20 +00001863 int sqlite3AutoLoadExtensions(sqlite3*);
drh69dab1d2006-06-27 14:37:20 +00001864#else
1865# define sqlite3CloseExtensions(X)
drh1409be62006-08-23 20:07:20 +00001866# define sqlite3AutoLoadExtensions(X) SQLITE_OK
drh69dab1d2006-06-27 14:37:20 +00001867#endif
danielk1977e3026632004-06-22 11:29:02 +00001868
danielk1977c00da102006-01-07 13:21:04 +00001869#ifndef SQLITE_OMIT_SHARED_CACHE
1870 void sqlite3TableLock(Parse *, int, int, u8, const char *);
1871#else
1872 #define sqlite3TableLock(v,w,x,y,z)
1873#endif
1874
drh53c14022007-05-10 17:23:11 +00001875#ifdef SQLITE_TEST
1876 int sqlite3Utf8To8(unsigned char*);
1877#endif
1878
drh17435752007-08-16 04:30:38 +00001879/*
drhd677b3d2007-08-20 22:48:41 +00001880** The MallocDisallow() and MallocAllow() routines are like asserts.
1881** Call them around a section of code that you do not expect to do
1882** any memory allocation.
drh17435752007-08-16 04:30:38 +00001883*/
drhd677b3d2007-08-20 22:48:41 +00001884#ifdef SQLITE_MEMDEBUG
1885 void sqlite3MallocDisallow(void);
1886 void sqlite3MallocAllow(void);
danielk1977a1644fd2007-08-29 12:31:25 +00001887 void sqlite3MallocBenignFailure(int);
drhd677b3d2007-08-20 22:48:41 +00001888#else
1889# define sqlite3MallocDisallow()
1890# define sqlite3MallocAllow()
danielk1977a1644fd2007-08-29 12:31:25 +00001891# define sqlite3MallocBenignFailure(x)
drhd677b3d2007-08-20 22:48:41 +00001892#endif
danielk19772e588c72005-12-09 14:25:08 +00001893
danielk1977750b03e2006-02-14 10:48:39 +00001894
drhb9bb7c12006-06-11 23:41:55 +00001895#ifdef SQLITE_OMIT_VIRTUALTABLE
1896# define sqlite3VtabClear(X)
danielk1977f9e7dda2006-06-16 16:08:53 +00001897# define sqlite3VtabSync(X,Y) (Y)
1898# define sqlite3VtabRollback(X)
1899# define sqlite3VtabCommit(X)
drhb9bb7c12006-06-11 23:41:55 +00001900#else
drh707205d2006-06-17 10:44:42 +00001901 void sqlite3VtabClear(Table*);
danielk1977f9e7dda2006-06-16 16:08:53 +00001902 int sqlite3VtabSync(sqlite3 *db, int rc);
1903 int sqlite3VtabRollback(sqlite3 *db);
1904 int sqlite3VtabCommit(sqlite3 *db);
drhb9bb7c12006-06-11 23:41:55 +00001905#endif
drh189d4af2006-09-02 20:57:52 +00001906void sqlite3VtabLock(sqlite3_vtab*);
danielk1977a04a34f2007-04-16 15:06:25 +00001907void sqlite3VtabUnlock(sqlite3*, sqlite3_vtab*);
drhb9bb7c12006-06-11 23:41:55 +00001908void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*);
1909void sqlite3VtabFinishParse(Parse*, Token*);
1910void sqlite3VtabArgInit(Parse*);
1911void sqlite3VtabArgExtend(Parse*, Token*);
danielk197778efaba2006-06-12 06:09:17 +00001912int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
danielk19777e6ebfb2006-06-12 11:24:37 +00001913int sqlite3VtabCallConnect(Parse*, Table*);
danielk19779e39ce82006-06-12 16:01:21 +00001914int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
danielk1977f9e7dda2006-06-16 16:08:53 +00001915int sqlite3VtabBegin(sqlite3 *, sqlite3_vtab *);
danielk19771e536952007-08-16 10:09:01 +00001916FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
drhb7481e72006-09-16 21:45:14 +00001917void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
drhb900aaf2006-11-09 00:24:53 +00001918int sqlite3Reprepare(Vdbe*);
danielk19777a15a4b2007-05-08 17:54:43 +00001919void sqlite3ExprListCheckLength(Parse*, ExprList*, int, const char*);
drh0a0e1312007-08-07 17:04:59 +00001920CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
drhb9bb7c12006-06-11 23:41:55 +00001921
danielk1977c7b60172007-08-22 11:22:03 +00001922#ifdef SQLITE_ENABLE_ATOMIC_WRITE
1923 int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
1924 int sqlite3JournalSize(sqlite3_vfs *);
danielk1977f55b8992007-08-24 08:15:53 +00001925 int sqlite3JournalCreate(sqlite3_file *);
danielk1977c7b60172007-08-22 11:22:03 +00001926#else
1927 #define sqlite3JournalSize(pVfs) ((pVfs)->szOsFile)
1928#endif
1929
danielk1977e6a58a42007-08-31 17:42:48 +00001930#if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
danielk1977fc976062007-05-10 10:46:56 +00001931 void sqlite3ExprSetHeight(Expr *);
1932 int sqlite3SelectExprHeight(Select *);
1933#else
1934 #define sqlite3ExprSetHeight(x)
1935#endif
1936
drha3152892007-05-05 11:48:52 +00001937u32 sqlite3Get4byte(const u8*);
drha3152892007-05-05 11:48:52 +00001938void sqlite3Put4byte(u8*, u32);
1939
danielk1977fd9a0a42005-05-24 12:01:00 +00001940#ifdef SQLITE_SSE
1941#include "sseInt.h"
1942#endif
1943
drh6e736832007-05-11 12:30:03 +00001944#ifdef SQLITE_DEBUG
1945 void sqlite3ParserTrace(FILE*, char *);
1946#endif
1947
drhb0603412007-02-28 04:47:26 +00001948/*
1949** If the SQLITE_ENABLE IOTRACE exists then the global variable
1950** sqlite3_io_trace is a pointer to a printf-like routine used to
1951** print I/O tracing messages.
1952*/
1953#ifdef SQLITE_ENABLE_IOTRACE
1954# define IOTRACE(A) if( sqlite3_io_trace ){ sqlite3_io_trace A; }
danielk1977b4622b62007-03-02 06:24:19 +00001955 void sqlite3VdbeIOTraceSql(Vdbe*);
drhb0603412007-02-28 04:47:26 +00001956#else
1957# define IOTRACE(A)
danielk1977b4622b62007-03-02 06:24:19 +00001958# define sqlite3VdbeIOTraceSql(X)
drhb0603412007-02-28 04:47:26 +00001959#endif
drh73be5012007-08-08 12:11:21 +00001960SQLITE_EXTERN void (*sqlite3_io_trace)(const char*,...);
drhb0603412007-02-28 04:47:26 +00001961
danielk1977e3026632004-06-22 11:29:02 +00001962#endif