blob: 481cbfe86e52a78fbf4d4c0d6e23b12eb19e6b30 [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**
drh3b020132008-04-17 17:02:01 +000014** @(#) $Id: sqliteInt.h,v 1.694 2008/04/17 17:02:02 drh Exp $
drh75897232000-05-29 14:26:00 +000015*/
danielk1977e3026632004-06-22 11:29:02 +000016#ifndef _SQLITEINT_H_
17#define _SQLITEINT_H_
drh71674ce2007-10-23 15:51:26 +000018
mlcreechbd0ae112008-03-06 09:16:24 +000019/*
mlcreech98dc4b12008-03-06 16:28:58 +000020** Include the configuration header output by 'configure' if it was run
21** (otherwise we get an empty default).
mlcreechbd0ae112008-03-06 09:16:24 +000022*/
mlcreech98dc4b12008-03-06 16:28:58 +000023#include "config.h"
drhbb4957f2008-03-20 14:03:29 +000024#include "sqliteLimit.h"
mlcreech98dc4b12008-03-06 16:28:58 +000025
drhe2965822008-04-10 16:47:41 +000026/* Disable nuisance warnings on Borland compilers */
27#if defined(__BORLANDC__)
28#pragma warn -rch /* unreachable code */
29#pragma warn -ccc /* Condition is always true or false */
30#pragma warn -aus /* Assigned value is never used */
31#pragma warn -csu /* Comparing signed and unsigned */
32#pragma warn -spa /* Suspicous pointer arithmetic */
33#endif
34
mlcreech98dc4b12008-03-06 16:28:58 +000035/* Needed for various definitions... */
36#define _GNU_SOURCE
37
38/*
39** Include standard header files as necessary
40*/
mlcreech98dc4b12008-03-06 16:28:58 +000041#ifdef HAVE_STDINT_H
42#include <stdint.h>
43#endif
44#ifdef HAVE_INTTYPES_H
45#include <inttypes.h>
mlcreecha9e852b2008-03-06 09:58:50 +000046#endif
47
mlcreech98dc4b12008-03-06 16:28:58 +000048/*
49** If possible, use the C99 intptr_t type to define an integral type of
50** equivalent size to a pointer. (Technically it's >= sizeof(void *), but
51** practically it's == sizeof(void *)). We fall back to an int if this type
52** isn't defined.
53*/
54#ifdef HAVE_INTPTR_T
55 typedef intptr_t sqlite3_intptr_t;
56#else
mlcreecha9e852b2008-03-06 09:58:50 +000057 typedef int sqlite3_intptr_t;
mlcreechbd0ae112008-03-06 09:16:24 +000058#endif
mlcreechb87057f2008-03-06 07:19:20 +000059
drhc5499be2008-04-01 15:06:33 +000060/*
61** A macro used to aid in coverage testing. When doing coverage
62** testing, the condition inside the argument must be evaluated
63** both true and false in order to get full branch coverage.
64** This macro can be inserted to ensure adequate test coverage
65** in places where simple condition/decision coverage is inadequate.
66*/
67#ifdef SQLITE_COVERAGE_TEST
68 void sqlite3Coverage(int);
69# define testcase(X) if( X ){ sqlite3Coverage(__LINE__); }
70#else
71# define testcase(X)
72#endif
73
mlcreech98dc4b12008-03-06 16:28:58 +000074
drh71674ce2007-10-23 15:51:26 +000075/*
drhb6dbc002007-11-27 02:38:00 +000076** The macro unlikely() is a hint that surrounds a boolean
77** expression that is usually false. Macro likely() surrounds
78** a boolean expression that is usually true. GCC is able to
79** use these hints to generate better code, sometimes.
80*/
drh4bbf4642008-01-30 16:14:23 +000081#if defined(__GNUC__) && 0
drhb6dbc002007-11-27 02:38:00 +000082# define likely(X) __builtin_expect((X),1)
83# define unlikely(X) __builtin_expect((X),0)
84#else
85# define likely(X) !!(X)
86# define unlikely(X) !!(X)
87#endif
88
89
90/*
drh71674ce2007-10-23 15:51:26 +000091** These #defines should enable >2GB file support on Posix if the
92** underlying operating system supports it. If the OS lacks
93** large file support, or if the OS is windows, these should be no-ops.
94**
95** Ticket #2739: The _LARGEFILE_SOURCE macro must appear before any
96** system #includes. Hence, this block of code must be the very first
97** code in all source files.
98**
99** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
100** on the compiler command line. This is necessary if you are compiling
101** on a recent machine (ex: RedHat 7.2) but you want your code to work
102** on an older machine (ex: RedHat 6.0). If you compile on RedHat 7.2
103** without this option, LFS is enable. But LFS does not exist in the kernel
104** in RedHat 6.0, so the code won't work. Hence, for maximum binary
105** portability you should omit LFS.
106**
107** Similar is true for MacOS. LFS is only supported on MacOS 9 and later.
108*/
109#ifndef SQLITE_DISABLE_LFS
110# define _LARGE_FILE 1
111# ifndef _FILE_OFFSET_BITS
112# define _FILE_OFFSET_BITS 64
113# endif
114# define _LARGEFILE_SOURCE 1
115#endif
116
117
drhe5e7a902007-10-01 17:47:00 +0000118/*
119** The SQLITE_THREADSAFE macro must be defined as either 0 or 1.
120** Older versions of SQLite used an optional THREADSAFE macro.
121** We support that for legacy
122*/
123#if !defined(SQLITE_THREADSAFE)
124#if defined(THREADSAFE)
125# define SQLITE_THREADSAFE THREADSAFE
126#else
127# define SQLITE_THREADSAFE 1
128#endif
129#endif
130
drh67080612007-10-01 14:30:14 +0000131/*
drh0d180202008-02-14 23:26:56 +0000132** Exactly one of the following macros must be defined in order to
133** specify which memory allocation subsystem to use.
134**
135** SQLITE_SYSTEM_MALLOC // Use normal system malloc()
136** SQLITE_MEMDEBUG // Debugging version of system malloc()
137** SQLITE_MEMORY_SIZE // internal allocator #1
138** SQLITE_MMAP_HEAP_SIZE // internal mmap() allocator
139** SQLITE_POW2_MEMORY_SIZE // internal power-of-two allocator
140**
141** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as
142** the default.
143*/
144#if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\
145 defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\
146 defined(SQLITE_POW2_MEMORY_SIZE)>1
147# error "At most one of the following compile-time configuration options\
148 is allows: SQLITE_SYSTEM_MALLOC, SQLITE_MEMDEBUG, SQLITE_MEMORY_SIZE,\
149 SQLITE_MMAP_HEAP_SIZE, SQLITE_POW2_MEMORY_SIZE"
150#endif
151#if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\
152 defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\
153 defined(SQLITE_POW2_MEMORY_SIZE)==0
154# define SQLITE_SYSTEM_MALLOC 1
155#endif
156
157/*
drheee4c8c2008-02-18 22:24:57 +0000158** If SQLITE_MALLOC_SOFT_LIMIT is defined, then try to keep the
159** sizes of memory allocations below this value where possible.
160*/
161#if defined(SQLITE_POW2_MEMORY_SIZE) && !defined(SQLITE_MALLOC_SOFT_LIMIT)
162# define SQLITE_MALLOC_SOFT_LIMIT 1024
163#endif
164
165/*
drh67080612007-10-01 14:30:14 +0000166** We need to define _XOPEN_SOURCE as follows in order to enable
167** recursive mutexes on most unix systems. But Mac OS X is different.
168** The _XOPEN_SOURCE define causes problems for Mac OS X we are told,
169** so it is omitted there. See ticket #2673.
drhe5e7a902007-10-01 17:47:00 +0000170**
171** Later we learn that _XOPEN_SOURCE is poorly or incorrectly
172** implemented on some systems. So we avoid defining it at all
173** if it is already defined or if it is unneeded because we are
174** not doing a threadsafe build. Ticket #2681.
drh9e0ebbf2007-10-23 15:59:18 +0000175**
176** See also ticket #2741.
drh67080612007-10-01 14:30:14 +0000177*/
aswiftee99b902008-01-28 22:09:23 +0000178#if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__) && SQLITE_THREADSAFE
drh67080612007-10-01 14:30:14 +0000179# define _XOPEN_SOURCE 500 /* Needed to enable pthread recursive mutexes */
180#endif
danielk1977e3026632004-06-22 11:29:02 +0000181
drh4f0c5872007-03-26 22:05:01 +0000182#if defined(SQLITE_TCL) || defined(TCLSH)
183# include <tcl.h>
drh824d7c12006-01-06 12:03:19 +0000184#endif
185
186/*
drh4b529d92005-09-13 00:00:00 +0000187** Many people are failing to set -DNDEBUG=1 when compiling SQLite.
drhb27795c2005-09-13 00:02:16 +0000188** Setting NDEBUG makes the code smaller and run faster. So the following
drh4b529d92005-09-13 00:00:00 +0000189** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1
190** option is set. Thus NDEBUG becomes an opt-in rather than an opt-out
191** feature.
192*/
danielk1977771151b2006-01-17 13:21:40 +0000193#if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
drh4b529d92005-09-13 00:00:00 +0000194# define NDEBUG 1
195#endif
196
drh1d482dd2004-05-31 18:23:07 +0000197#include "sqlite3.h"
drhbeae3192001-09-22 18:12:08 +0000198#include "hash.h"
drh75897232000-05-29 14:26:00 +0000199#include "parse.h"
drh75897232000-05-29 14:26:00 +0000200#include <stdio.h>
201#include <stdlib.h>
202#include <string.h>
203#include <assert.h>
drh52370e22005-01-21 21:31:40 +0000204#include <stddef.h>
drh75897232000-05-29 14:26:00 +0000205
drh7cd69272007-06-20 15:29:25 +0000206#define sqlite3_isnan(X) ((X)!=(X))
drh7361cb12007-06-10 22:57:33 +0000207
drh967e8b72000-06-21 13:59:10 +0000208/*
drhb37df7b2005-10-13 02:09:49 +0000209** If compiling for a processor that lacks floating point support,
210** substitute integer for floating-point
211*/
212#ifdef SQLITE_OMIT_FLOATING_POINT
213# define double sqlite_int64
214# define LONGDOUBLE_TYPE sqlite_int64
drhd1167392006-01-23 13:00:35 +0000215# ifndef SQLITE_BIG_DBL
216# define SQLITE_BIG_DBL (0x7fffffffffffffff)
217# endif
drhb37df7b2005-10-13 02:09:49 +0000218# define SQLITE_OMIT_DATETIME_FUNCS 1
219# define SQLITE_OMIT_TRACE 1
drh110daac2007-05-04 11:59:31 +0000220# undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
drhb37df7b2005-10-13 02:09:49 +0000221#endif
drhd1167392006-01-23 13:00:35 +0000222#ifndef SQLITE_BIG_DBL
223# define SQLITE_BIG_DBL (1e99)
224#endif
drhb37df7b2005-10-13 02:09:49 +0000225
226/*
danielk197753c0f742005-03-29 03:10:59 +0000227** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
228** afterward. Having this macro allows us to cause the C compiler
229** to omit code used by TEMP tables without messy #ifndef statements.
230*/
231#ifdef SQLITE_OMIT_TEMPDB
232#define OMIT_TEMPDB 1
233#else
234#define OMIT_TEMPDB 0
235#endif
236
237/*
drh0bd1f4e2002-06-06 18:54:39 +0000238** If the following macro is set to 1, then NULL values are considered
drh0bd1f4e2002-06-06 18:54:39 +0000239** distinct when determining whether or not two entries are the same
240** in a UNIQUE index. This is the way PostgreSQL, Oracle, DB2, MySQL,
241** OCELOT, and Firebird all work. The SQL92 spec explicitly says this
242** is the way things are suppose to work.
243**
244** If the following macro is set to 0, the NULLs are indistinct for
245** a UNIQUE index. In this mode, you can only have a single NULL entry
246** for a column declared UNIQUE. This is the way Informix and SQL Server
247** work.
248*/
249#define NULL_DISTINCT_FOR_UNIQUE 1
250
251/*
drhd946db02005-12-29 19:23:06 +0000252** The "file format" number is an integer that is incremented whenever
253** the VDBE-level file format changes. The following macros define the
254** the default file format for new databases and the maximum file format
255** that the library can read.
256*/
257#define SQLITE_MAX_FILE_FORMAT 4
258#ifndef SQLITE_DEFAULT_FILE_FORMAT
drh76fe8032006-07-11 14:17:51 +0000259# define SQLITE_DEFAULT_FILE_FORMAT 1
drhd946db02005-12-29 19:23:06 +0000260#endif
261
262/*
drh49766d62005-01-08 18:42:28 +0000263** Provide a default value for TEMP_STORE in case it is not specified
264** on the command-line
265*/
266#ifndef TEMP_STORE
267# define TEMP_STORE 1
268#endif
269
270/*
drhf1974842004-11-05 03:56:00 +0000271** GCC does not define the offsetof() macro so we'll have to do it
272** ourselves.
273*/
274#ifndef offsetof
275#define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
276#endif
277
278/*
drh9b8f4472006-04-04 01:54:55 +0000279** Check to see if this machine uses EBCDIC. (Yes, believe it or
280** not, there are still machines out there that use EBCDIC.)
281*/
282#if 'A' == '\301'
283# define SQLITE_EBCDIC 1
284#else
285# define SQLITE_ASCII 1
286#endif
287
288/*
drh5a2c2c22001-11-21 02:21:11 +0000289** Integers of known sizes. These typedefs might change for architectures
290** where the sizes very. Preprocessor macros are available so that the
291** types can be conveniently redefined at compile-type. Like this:
292**
293** cc '-DUINTPTR_TYPE=long long int' ...
drh41a2b482001-01-20 19:52:49 +0000294*/
drh5a2c2c22001-11-21 02:21:11 +0000295#ifndef UINT32_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000296# ifdef HAVE_UINT32_T
297# define UINT32_TYPE uint32_t
298# else
299# define UINT32_TYPE unsigned int
300# endif
drh5a2c2c22001-11-21 02:21:11 +0000301#endif
302#ifndef UINT16_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000303# ifdef HAVE_UINT16_T
304# define UINT16_TYPE uint16_t
305# else
306# define UINT16_TYPE unsigned short int
307# endif
drh5a2c2c22001-11-21 02:21:11 +0000308#endif
drh939a16d2004-07-15 13:37:22 +0000309#ifndef INT16_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000310# ifdef HAVE_INT16_T
311# define INT16_TYPE int16_t
312# else
313# define INT16_TYPE short int
314# endif
drh939a16d2004-07-15 13:37:22 +0000315#endif
drh5a2c2c22001-11-21 02:21:11 +0000316#ifndef UINT8_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000317# ifdef HAVE_UINT8_T
318# define UINT8_TYPE uint8_t
319# else
320# define UINT8_TYPE unsigned char
321# endif
drh5a2c2c22001-11-21 02:21:11 +0000322#endif
drh905793e2004-02-21 13:31:09 +0000323#ifndef INT8_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000324# ifdef HAVE_INT8_T
325# define INT8_TYPE int8_t
326# else
327# define INT8_TYPE signed char
328# endif
drh905793e2004-02-21 13:31:09 +0000329#endif
drhefad9992004-06-22 12:13:55 +0000330#ifndef LONGDOUBLE_TYPE
331# define LONGDOUBLE_TYPE long double
332#endif
drhefad9992004-06-22 12:13:55 +0000333typedef sqlite_int64 i64; /* 8-byte signed integer */
drh27436af2006-03-28 23:57:17 +0000334typedef sqlite_uint64 u64; /* 8-byte unsigned integer */
drh5a2c2c22001-11-21 02:21:11 +0000335typedef UINT32_TYPE u32; /* 4-byte unsigned integer */
336typedef UINT16_TYPE u16; /* 2-byte unsigned integer */
drh939a16d2004-07-15 13:37:22 +0000337typedef INT16_TYPE i16; /* 2-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000338typedef UINT8_TYPE u8; /* 1-byte unsigned integer */
drh905793e2004-02-21 13:31:09 +0000339typedef UINT8_TYPE i8; /* 1-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000340
341/*
drhbbd42a62004-05-22 17:41:58 +0000342** Macros to determine whether the machine is big or little endian,
343** evaluated at runtime.
344*/
drh46c99e02007-08-27 23:26:59 +0000345#ifdef SQLITE_AMALGAMATION
mlcreech7ff4a452008-03-06 09:19:00 +0000346const int sqlite3one;
drh46c99e02007-08-27 23:26:59 +0000347#else
drhbbd42a62004-05-22 17:41:58 +0000348extern const int sqlite3one;
drh46c99e02007-08-27 23:26:59 +0000349#endif
drh38def052007-03-31 15:27:59 +0000350#if defined(i386) || defined(__i386__) || defined(_M_IX86)
351# define SQLITE_BIGENDIAN 0
352# define SQLITE_LITTLEENDIAN 1
353# define SQLITE_UTF16NATIVE SQLITE_UTF16LE
354#else
355# define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0)
356# define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
357# define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
358#endif
drhbbd42a62004-05-22 17:41:58 +0000359
360/*
drh90f5ecb2004-07-22 01:19:35 +0000361** An instance of the following structure is used to store the busy-handler
362** callback for a given sqlite handle.
363**
364** The sqlite.busyHandler member of the sqlite struct contains the busy
365** callback for the database handle. Each pager opened via the sqlite
366** handle is passed a pointer to sqlite.busyHandler. The busy-handler
367** callback is currently invoked only from within pager.c.
368*/
369typedef struct BusyHandler BusyHandler;
370struct BusyHandler {
371 int (*xFunc)(void *,int); /* The busy callback */
372 void *pArg; /* First arg to busy callback */
drha4afb652005-07-09 02:16:02 +0000373 int nBusy; /* Incremented with each busy call */
drh90f5ecb2004-07-22 01:19:35 +0000374};
375
376/*
drh75897232000-05-29 14:26:00 +0000377** Name of the master database table. The master database table
378** is a special table that holds the names and attributes of all
379** user tables and indices.
380*/
drhe0bc4042002-06-25 01:09:11 +0000381#define MASTER_NAME "sqlite_master"
382#define TEMP_MASTER_NAME "sqlite_temp_master"
drh75897232000-05-29 14:26:00 +0000383
384/*
danielk19778e150812004-05-10 01:17:37 +0000385** The root-page of the master database table.
386*/
387#define MASTER_ROOT 1
388
389/*
drhed6c8672003-01-12 18:02:16 +0000390** The name of the schema table.
391*/
danielk197753c0f742005-03-29 03:10:59 +0000392#define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
drhed6c8672003-01-12 18:02:16 +0000393
394/*
drh75897232000-05-29 14:26:00 +0000395** A convenience macro that returns the number of elements in
396** an array.
397*/
398#define ArraySize(X) (sizeof(X)/sizeof(X[0]))
399
400/*
401** Forward references to structures
402*/
drh13449892005-09-07 21:22:45 +0000403typedef struct AggInfo AggInfo;
drhfe05af82005-07-21 03:14:59 +0000404typedef struct AuthContext AuthContext;
drhf5e7bb52008-02-18 14:47:33 +0000405typedef struct Bitvec Bitvec;
drhfe05af82005-07-21 03:14:59 +0000406typedef struct CollSeq CollSeq;
drh7020f652000-06-03 18:06:52 +0000407typedef struct Column Column;
drhfe05af82005-07-21 03:14:59 +0000408typedef struct Db Db;
danielk1977e501b892006-01-09 06:29:47 +0000409typedef struct Schema Schema;
drh75897232000-05-29 14:26:00 +0000410typedef struct Expr Expr;
411typedef struct ExprList ExprList;
drhc2eef3b2002-08-31 18:53:06 +0000412typedef struct FKey FKey;
drhfe05af82005-07-21 03:14:59 +0000413typedef struct FuncDef FuncDef;
414typedef struct IdList IdList;
415typedef struct Index Index;
danielk19778d059842004-05-12 11:24:02 +0000416typedef struct KeyClass KeyClass;
drhd3d39e92004-05-20 22:16:29 +0000417typedef struct KeyInfo KeyInfo;
danielk1977d1ab1ba2006-06-15 04:28:13 +0000418typedef struct Module Module;
drh626a8792005-01-17 22:08:19 +0000419typedef struct NameContext NameContext;
drhfe05af82005-07-21 03:14:59 +0000420typedef struct Parse Parse;
421typedef struct Select Select;
422typedef struct SrcList SrcList;
drhade86482007-11-28 22:36:40 +0000423typedef struct StrAccum StrAccum;
drhfe05af82005-07-21 03:14:59 +0000424typedef struct Table Table;
danielk1977c00da102006-01-07 13:21:04 +0000425typedef struct TableLock TableLock;
drhfe05af82005-07-21 03:14:59 +0000426typedef struct Token Token;
427typedef struct TriggerStack TriggerStack;
428typedef struct TriggerStep TriggerStep;
429typedef struct Trigger Trigger;
drhfe05af82005-07-21 03:14:59 +0000430typedef struct WhereInfo WhereInfo;
431typedef struct WhereLevel WhereLevel;
drhd3d39e92004-05-20 22:16:29 +0000432
danielk19772dca4ac2008-01-03 11:50:29 +0000433/*
434** Defer sourcing vdbe.h and btree.h until after the "u8" and
435** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
436** pointer types (i.e. FuncDef) defined above.
437*/
438#include "btree.h"
439#include "vdbe.h"
440#include "pager.h"
441
danielk19771cc5ed82007-05-16 17:28:43 +0000442#include "os.h"
drhc7ce76a2007-08-30 14:10:30 +0000443#include "mutex.h"
danielk19771cc5ed82007-05-16 17:28:43 +0000444
drheee4c8c2008-02-18 22:24:57 +0000445
drh001bbcb2003-03-19 03:14:00 +0000446/*
447** Each database file to be accessed by the system is an instance
448** of the following structure. There are normally two of these structures
449** in the sqlite.aDb[] array. aDb[0] is the main database file and
drha69d9162003-04-17 22:57:53 +0000450** aDb[1] is the database file used to hold temporary tables. Additional
451** databases may be attached.
drh001bbcb2003-03-19 03:14:00 +0000452*/
453struct Db {
454 char *zName; /* Name of this database */
455 Btree *pBt; /* The B*Tree structure for this database file */
danielk1977da184232006-01-05 11:34:32 +0000456 u8 inTrans; /* 0: not writable. 1: Transaction. 2: Checkpoint */
457 u8 safety_level; /* How aggressive at synching data to disk */
danielk1977da184232006-01-05 11:34:32 +0000458 void *pAux; /* Auxiliary data. Usually NULL */
459 void (*xFreeAux)(void*); /* Routine to free pAux */
danielk1977e501b892006-01-09 06:29:47 +0000460 Schema *pSchema; /* Pointer to database schema (possibly shared) */
danielk1977da184232006-01-05 11:34:32 +0000461};
462
463/*
464** An instance of the following structure stores a database schema.
danielk1977a04a34f2007-04-16 15:06:25 +0000465**
466** If there are no virtual tables configured in this schema, the
467** Schema.db variable is set to NULL. After the first virtual table
468** has been added, it is set to point to the database connection
469** used to create the connection. Once a virtual table has been
470** added to the Schema structure and the Schema.db variable populated,
471** only that database connection may use the Schema to prepare
472** statements.
danielk1977da184232006-01-05 11:34:32 +0000473*/
danielk1977e501b892006-01-09 06:29:47 +0000474struct Schema {
drh001bbcb2003-03-19 03:14:00 +0000475 int schema_cookie; /* Database schema version number for this file */
drhd24cc422003-03-27 12:51:24 +0000476 Hash tblHash; /* All tables indexed by name */
477 Hash idxHash; /* All (named) indices indexed by name */
478 Hash trigHash; /* All triggers indexed by name */
479 Hash aFKey; /* Foreign keys indexed by to-table */
drh4794f732004-11-05 17:17:50 +0000480 Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */
danielk1977da184232006-01-05 11:34:32 +0000481 u8 file_format; /* Schema format version for this file */
drh8079a0d2006-01-12 17:20:50 +0000482 u8 enc; /* Text encoding used by this database */
danielk1977da184232006-01-05 11:34:32 +0000483 u16 flags; /* Flags associated with this schema */
danielk197714db2662006-01-09 16:12:04 +0000484 int cache_size; /* Number of pages to use in the cache */
danielk1977a04a34f2007-04-16 15:06:25 +0000485#ifndef SQLITE_OMIT_VIRTUALTABLE
486 sqlite3 *db; /* "Owner" connection. See comment above */
487#endif
drh001bbcb2003-03-19 03:14:00 +0000488};
drh75897232000-05-29 14:26:00 +0000489
490/*
drh8bf8dc92003-05-17 17:35:10 +0000491** These macros can be used to test, set, or clear bits in the
492** Db.flags field.
493*/
danielk1977da184232006-01-05 11:34:32 +0000494#define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))==(P))
495#define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))!=0)
496#define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->flags|=(P)
497#define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->flags&=~(P)
drh8bf8dc92003-05-17 17:35:10 +0000498
499/*
500** Allowed values for the DB.flags field.
501**
drh8bf8dc92003-05-17 17:35:10 +0000502** The DB_SchemaLoaded flag is set after the database schema has been
503** read into internal hash tables.
504**
505** DB_UnresetViews means that one or more views have column names that
506** have been filled out. If the schema changes, these column names might
507** changes and so the view will need to be reset.
508*/
drh124b27e2004-06-19 16:06:10 +0000509#define DB_SchemaLoaded 0x0001 /* The schema has been loaded */
510#define DB_UnresetViews 0x0002 /* Some views have defined column names */
danielk1977b82e7ed2006-01-11 14:09:31 +0000511#define DB_Empty 0x0004 /* The file is empty (length 0 bytes) */
drh8bf8dc92003-05-17 17:35:10 +0000512
drhcaa639f2008-03-20 00:32:20 +0000513/*
514** The number of different kinds of things that can be limited
515** using the sqlite3_limit() interface.
516*/
517#define SQLITE_N_LIMIT (SQLITE_LIMIT_VARIABLE_NUMBER+1)
drh8bf8dc92003-05-17 17:35:10 +0000518
519/*
drhc9b84a12002-06-20 11:36:48 +0000520** Each database is an instance of the following structure.
521**
rdcb0c374f2004-02-20 22:53:38 +0000522** The sqlite.lastRowid records the last insert rowid generated by an
523** insert statement. Inserts on views do not affect its value. Each
524** trigger has its own context, so that lastRowid can be updated inside
525** triggers as usual. The previous value will be restored once the trigger
526** exits. Upon entering a before or instead of trigger, lastRowid is no
527** longer (since after version 2.8.12) reset to -1.
528**
529** The sqlite.nChange does not count changes within triggers and keeps no
danielk19776f8a5032004-05-10 10:34:51 +0000530** context. It is reset at start of sqlite3_exec.
rdcb0c374f2004-02-20 22:53:38 +0000531** The sqlite.lsChange represents the number of changes made by the last
532** insert, update, or delete statement. It remains constant throughout the
533** length of a statement and is then updated by OP_SetCounts. It keeps a
534** context stack just like lastRowid so that the count of changes
535** within a trigger is not seen outside the trigger. Changes to views do not
536** affect the value of lsChange.
537** The sqlite.csChange keeps track of the number of current changes (since
538** the last statement) and is used to update sqlite_lsChange.
danielk19776622cce2004-05-20 11:00:52 +0000539**
540** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
541** store the most recent error code and, if applicable, string. The
542** internal function sqlite3Error() is used to set these variables
543** consistently.
drh75897232000-05-29 14:26:00 +0000544*/
drh9bb575f2004-09-06 17:24:11 +0000545struct sqlite3 {
drh90f6a5b2007-08-15 13:04:54 +0000546 sqlite3_vfs *pVfs; /* OS Interface */
drh001bbcb2003-03-19 03:14:00 +0000547 int nDb; /* Number of backends currently in use */
548 Db *aDb; /* All backends */
drh5e00f6c2001-09-13 13:46:56 +0000549 int flags; /* Miscellanous flags. See below */
drh33f4e022007-09-03 15:19:34 +0000550 int openFlags; /* Flags passed to sqlite3_vfs.xOpen() */
drhfcd35c72005-05-21 02:48:08 +0000551 int errCode; /* Most recent error code (SQLITE_*) */
drh4ac285a2006-09-15 07:28:50 +0000552 int errMask; /* & result codes with this before returning */
drhfcd35c72005-05-21 02:48:08 +0000553 u8 autoCommit; /* The auto-commit flag. */
drh90f5ecb2004-07-22 01:19:35 +0000554 u8 temp_store; /* 1: file 2: memory 0: default */
drh17435752007-08-16 04:30:38 +0000555 u8 mallocFailed; /* True if we have seen a malloc failure */
drh3b020132008-04-17 17:02:01 +0000556 u8 dfltLockMode; /* Default locking-mode for attached dbs */
557 u8 dfltJournalMode; /* Default journal mode for attached dbs */
drh98757152008-01-09 23:04:12 +0000558 signed char nextAutovac; /* Autovac setting after VACUUM if >=0 */
danielk1977f653d782008-03-20 11:04:21 +0000559 int nextPagesize; /* Pagesize after VACUUM if >0 */
drh5e00f6c2001-09-13 13:46:56 +0000560 int nTable; /* Number of tables in the database */
drhd3d39e92004-05-20 22:16:29 +0000561 CollSeq *pDfltColl; /* The default collating sequence (BINARY) */
drhf328bc82004-05-10 23:29:49 +0000562 i64 lastRowid; /* ROWID of most recent insert (see above) */
563 i64 priorNewRowid; /* Last randomly generated ROWID */
drh247be432002-05-10 05:44:55 +0000564 int magic; /* Magic number for detect library misuse */
danielk1977b28af712004-06-21 06:50:26 +0000565 int nChange; /* Value returned by sqlite3_changes() */
566 int nTotalChange; /* Value returned by sqlite3_total_changes() */
drhd677b3d2007-08-20 22:48:41 +0000567 sqlite3_mutex *mutex; /* Connection mutex */
drhcaa639f2008-03-20 00:32:20 +0000568 int aLimit[SQLITE_N_LIMIT]; /* Limits */
danielk1977b28af712004-06-21 06:50:26 +0000569 struct sqlite3InitInfo { /* Information used during initialization */
570 int iDb; /* When back is being initialized */
571 int newTnum; /* Rootpage of table being initialized */
572 u8 busy; /* TRUE if currently initializing */
drh1d85d932004-02-14 23:05:52 +0000573 } init;
drhf1952c52006-06-08 15:48:00 +0000574 int nExtension; /* Number of loaded extensions */
drh761df872006-12-21 01:29:22 +0000575 void **aExtension; /* Array of shared libraray handles */
drh326dce72003-01-29 14:06:07 +0000576 struct Vdbe *pVdbe; /* List of active virtual machines */
danielk19771d850a72004-05-31 08:26:49 +0000577 int activeVdbeCnt; /* Number of vdbes currently executing */
drh19e2d372005-08-29 23:00:03 +0000578 void (*xTrace)(void*,const char*); /* Trace function */
579 void *pTraceArg; /* Argument to the trace function */
580 void (*xProfile)(void*,const char*,u64); /* Profiling function */
581 void *pProfileArg; /* Argument to profile function */
danielk197771fd80b2005-12-16 06:54:01 +0000582 void *pCommitArg; /* Argument to xCommitCallback() */
583 int (*xCommitCallback)(void*); /* Invoked at every commit. */
584 void *pRollbackArg; /* Argument to xRollbackCallback() */
585 void (*xRollbackCallback)(void*); /* Invoked at every commit. */
danielk197794eb6a12005-12-15 15:22:08 +0000586 void *pUpdateArg;
587 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
drhfcd35c72005-05-21 02:48:08 +0000588 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
589 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
590 void *pCollNeededArg;
drhfcd35c72005-05-21 02:48:08 +0000591 sqlite3_value *pErr; /* Most recent error message */
592 char *zErrMsg; /* Most recent error message (UTF-8 encoded) */
593 char *zErrMsg16; /* Most recent error message (UTF-16 encoded) */
drh881feaa2006-07-26 01:39:30 +0000594 union {
595 int isInterrupted; /* True if sqlite3_interrupt has been called */
596 double notUsed1; /* Spacer */
597 } u1;
drhed6c8672003-01-12 18:02:16 +0000598#ifndef SQLITE_OMIT_AUTHORIZATION
drhe22a3342003-04-22 20:30:37 +0000599 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
600 /* Access authorization function */
drhed6c8672003-01-12 18:02:16 +0000601 void *pAuthArg; /* 1st argument to the access auth function */
602#endif
danielk1977348bb5d2003-10-18 09:37:26 +0000603#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
604 int (*xProgress)(void *); /* The progress callback */
605 void *pProgressArg; /* Argument to the progress callback */
606 int nProgressOps; /* Number of opcodes for progress callback */
607#endif
drhb9bb7c12006-06-11 23:41:55 +0000608#ifndef SQLITE_OMIT_VIRTUALTABLE
609 Hash aModule; /* populated by sqlite3_create_module() */
danielk19777e6ebfb2006-06-12 11:24:37 +0000610 Table *pVTab; /* vtab with active Connect/Create method */
danielk1977f9e7dda2006-06-16 16:08:53 +0000611 sqlite3_vtab **aVTrans; /* Virtual tables with open transactions */
612 int nVTrans; /* Allocated size of aVTrans */
danielk19776b456a22005-03-21 04:04:02 +0000613#endif
drhfcd35c72005-05-21 02:48:08 +0000614 Hash aFunc; /* All functions that can be in SQL exprs */
615 Hash aCollSeq; /* All collating sequences */
616 BusyHandler busyHandler; /* Busy callback */
drhb9bb7c12006-06-11 23:41:55 +0000617 int busyTimeout; /* Busy handler timeout, in msec */
drhfcd35c72005-05-21 02:48:08 +0000618 Db aDbStatic[2]; /* Static space for the 2 default backends */
danielk19777e900ab2005-05-23 04:51:01 +0000619#ifdef SQLITE_SSE
620 sqlite3_stmt *pFetch; /* Used by SSE to fetch stored statements */
621#endif
drh75897232000-05-29 14:26:00 +0000622};
623
drh03b808a2006-03-13 15:06:05 +0000624/*
625** A macro to discover the encoding of a database.
626*/
danielk197714db2662006-01-09 16:12:04 +0000627#define ENC(db) ((db)->aDb[0].pSchema->enc)
628
drh75897232000-05-29 14:26:00 +0000629/*
drh8bf8dc92003-05-17 17:35:10 +0000630** Possible values for the sqlite.flags and or Db.flags fields.
631**
632** On sqlite.flags, the SQLITE_InTrans value means that we have
633** executed a BEGIN. On Db.flags, SQLITE_InTrans means a statement
634** transaction is active on that particular database file.
drh75897232000-05-29 14:26:00 +0000635*/
drh5e00f6c2001-09-13 13:46:56 +0000636#define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */
drh5e00f6c2001-09-13 13:46:56 +0000637#define SQLITE_InTrans 0x00000008 /* True if in a transaction */
638#define SQLITE_InternChanges 0x00000010 /* Uncommitted Hash table changes */
drh382c0242001-10-06 16:33:02 +0000639#define SQLITE_FullColNames 0x00000020 /* Show full column names on SELECT */
drhfcabd462004-02-20 14:50:58 +0000640#define SQLITE_ShortColNames 0x00000040 /* Show short columns names */
641#define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */
drh1bee3d72001-10-15 00:44:35 +0000642 /* DELETE, or UPDATE and return */
643 /* the count using a callback. */
drhfcabd462004-02-20 14:50:58 +0000644#define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */
drh6a535342001-10-19 16:44:56 +0000645 /* result set is empty */
drh35d4c2f2004-06-10 01:30:59 +0000646#define SQLITE_SqlTrace 0x00000200 /* Debug print SQL as it executes */
647#define SQLITE_VdbeListing 0x00000400 /* Debug listings of VDBE programs */
drhf4040832004-10-22 20:29:21 +0000648#define SQLITE_WriteSchema 0x00000800 /* OK to update SQLITE_MASTER */
drh7bec5052005-02-06 02:45:41 +0000649#define SQLITE_NoReadlock 0x00001000 /* Readlocks are omitted when
650 ** accessing read-only databases */
drh0cd2d4c2005-11-03 02:15:02 +0000651#define SQLITE_IgnoreChecks 0x00002000 /* Do not enforce check constraints */
drhc2e87a32006-06-27 15:16:14 +0000652#define SQLITE_ReadUncommitted 0x00004000 /* For shared-cache mode */
drhe321c292006-01-12 01:56:43 +0000653#define SQLITE_LegacyFileFmt 0x00008000 /* Create new databases in format 1 */
drhac530b12006-02-11 01:25:50 +0000654#define SQLITE_FullFSync 0x00010000 /* Use full fsync on the backend */
drhc2e87a32006-06-27 15:16:14 +0000655#define SQLITE_LoadExtension 0x00020000 /* Enable load_extension */
drh58b95762000-06-02 01:17:37 +0000656
danielk197734c68fb2007-03-14 15:37:04 +0000657#define SQLITE_RecoveryMode 0x00040000 /* Ignore schema errors */
drh4a50aac2007-08-23 02:47:53 +0000658#define SQLITE_SharedCache 0x00080000 /* Cache sharing is enabled */
659#define SQLITE_Vtab 0x00100000 /* There exists a virtual table */
danielk197734c68fb2007-03-14 15:37:04 +0000660
drh58b95762000-06-02 01:17:37 +0000661/*
drh247be432002-05-10 05:44:55 +0000662** Possible values for the sqlite.magic field.
663** The numbers are obtained at random and have no special meaning, other
664** than being distinct from one another.
665*/
666#define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */
667#define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */
drh7e8b8482008-01-23 03:03:05 +0000668#define SQLITE_MAGIC_SICK 0x4b771290 /* Error and awaiting close */
drh247be432002-05-10 05:44:55 +0000669#define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */
670#define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */
671
672/*
drh0bce8352002-02-28 00:41:10 +0000673** Each SQL function is defined by an instance of the following
674** structure. A pointer to this structure is stored in the sqlite.aFunc
drh8e0a2f92002-02-23 23:45:45 +0000675** hash table. When multiple functions have the same name, the hash table
676** points to a linked list of these structures.
drh28037572000-08-02 13:47:41 +0000677*/
drh0bce8352002-02-28 00:41:10 +0000678struct FuncDef {
drh55ef4d92005-08-14 01:20:37 +0000679 i16 nArg; /* Number of arguments. -1 means unlimited */
danielk1977d8123362004-06-12 09:25:12 +0000680 u8 iPrefEnc; /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
drh55ef4d92005-08-14 01:20:37 +0000681 u8 needCollSeq; /* True if sqlite3GetFuncCollSeq() might be called */
682 u8 flags; /* Some combination of SQLITE_FUNC_* */
drhf9b596e2004-05-26 16:54:42 +0000683 void *pUserData; /* User data parameter */
684 FuncDef *pNext; /* Next function with same name */
685 void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
686 void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
687 void (*xFinalize)(sqlite3_context*); /* Aggregate finializer */
drh55ef4d92005-08-14 01:20:37 +0000688 char zName[1]; /* SQL name of the function. MUST BE LAST */
drh8e0a2f92002-02-23 23:45:45 +0000689};
drh28037572000-08-02 13:47:41 +0000690
691/*
danielk1977d1ab1ba2006-06-15 04:28:13 +0000692** Each SQLite module (virtual table definition) is defined by an
693** instance of the following structure, stored in the sqlite3.aModule
694** hash table.
695*/
696struct Module {
697 const sqlite3_module *pModule; /* Callback pointers */
698 const char *zName; /* Name passed to create_module() */
699 void *pAux; /* pAux passed to create_module() */
danielk1977832a58a2007-06-22 15:21:15 +0000700 void (*xDestroy)(void *); /* Module destructor function */
danielk1977d1ab1ba2006-06-15 04:28:13 +0000701};
702
703/*
drh55ef4d92005-08-14 01:20:37 +0000704** Possible values for FuncDef.flags
705*/
drhd64fe2f2005-08-28 17:00:23 +0000706#define SQLITE_FUNC_LIKE 0x01 /* Candidate for the LIKE optimization */
707#define SQLITE_FUNC_CASE 0x02 /* Case-sensitive LIKE-type function */
drhb7f6f682006-07-08 17:06:43 +0000708#define SQLITE_FUNC_EPHEM 0x04 /* Ephermeral. Delete with VDBE */
drh55ef4d92005-08-14 01:20:37 +0000709
710/*
drh967e8b72000-06-21 13:59:10 +0000711** information about each column of an SQL table is held in an instance
drh7020f652000-06-03 18:06:52 +0000712** of this structure.
713*/
714struct Column {
drh967e8b72000-06-21 13:59:10 +0000715 char *zName; /* Name of this column */
danielk19777977a172004-11-09 12:44:37 +0000716 Expr *pDflt; /* Default value of this column */
drh382c0242001-10-06 16:33:02 +0000717 char *zType; /* Data type for this column */
danielk1977b3bf5562006-01-10 17:58:23 +0000718 char *zColl; /* Collating sequence. If NULL, use the default */
drh4a324312001-12-21 14:30:42 +0000719 u8 notNull; /* True if there is a NOT NULL constraint */
drh78100cc2003-08-23 22:40:53 +0000720 u8 isPrimKey; /* True if this column is part of the PRIMARY KEY */
danielk1977a37cdde2004-05-16 11:15:36 +0000721 char affinity; /* One of the SQLITE_AFF_... values */
danielk1977034ca142007-06-26 10:38:54 +0000722#ifndef SQLITE_OMIT_VIRTUALTABLE
723 u8 isHidden; /* True if this column is 'hidden' */
724#endif
drh7020f652000-06-03 18:06:52 +0000725};
726
727/*
drha9fd84b2004-05-18 23:21:35 +0000728** A "Collating Sequence" is defined by an instance of the following
danielk19770202b292004-06-09 09:55:16 +0000729** structure. Conceptually, a collating sequence consists of a name and
730** a comparison routine that defines the order of that sequence.
drha9fd84b2004-05-18 23:21:35 +0000731**
danielk19770202b292004-06-09 09:55:16 +0000732** There may two seperate implementations of the collation function, one
733** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
734** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
735** native byte order. When a collation sequence is invoked, SQLite selects
736** the version that will require the least expensive encoding
danielk1977b3bf5562006-01-10 17:58:23 +0000737** translations, if any.
danielk19770202b292004-06-09 09:55:16 +0000738**
739** The CollSeq.pUser member variable is an extra parameter that passed in
740** as the first argument to the UTF-8 comparison function, xCmp.
741** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
742** xCmp16.
743**
744** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
745** collating sequence is undefined. Indices built on an undefined
746** collating sequence may not be read or written.
drha9fd84b2004-05-18 23:21:35 +0000747*/
748struct CollSeq {
danielk1977a9808b32007-05-07 09:32:45 +0000749 char *zName; /* Name of the collating sequence, UTF-8 encoded */
750 u8 enc; /* Text encoding handled by xCmp() */
751 u8 type; /* One of the SQLITE_COLL_... values below */
752 void *pUser; /* First argument to xCmp() */
danielk19770202b292004-06-09 09:55:16 +0000753 int (*xCmp)(void*,int, const void*, int, const void*);
danielk1977a9808b32007-05-07 09:32:45 +0000754 void (*xDel)(void*); /* Destructor for pUser */
drha9fd84b2004-05-18 23:21:35 +0000755};
756
757/*
drhd64fe2f2005-08-28 17:00:23 +0000758** Allowed values of CollSeq flags:
759*/
760#define SQLITE_COLL_BINARY 1 /* The default memcmp() collating sequence */
761#define SQLITE_COLL_NOCASE 2 /* The built-in NOCASE collating sequence */
762#define SQLITE_COLL_REVERSE 3 /* The built-in REVERSE collating sequence */
763#define SQLITE_COLL_USER 0 /* Any other user-defined collating sequence */
764
765/*
drhd3d39e92004-05-20 22:16:29 +0000766** A sort order can be either ASC or DESC.
drh8e2ca022002-06-17 17:07:19 +0000767*/
drh8e2ca022002-06-17 17:07:19 +0000768#define SQLITE_SO_ASC 0 /* Sort in ascending order */
drhd3d39e92004-05-20 22:16:29 +0000769#define SQLITE_SO_DESC 1 /* Sort in ascending order */
drh8e2ca022002-06-17 17:07:19 +0000770
771/*
danielk1977a37cdde2004-05-16 11:15:36 +0000772** Column affinity types.
drh8a512562005-11-14 22:29:05 +0000773**
774** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
775** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve
776** the speed a little by number the values consecutively.
777**
778** But rather than start with 0 or 1, we begin with 'a'. That way,
779** when multiple affinity types are concatenated into a string and
drh66a51672008-01-03 00:01:23 +0000780** used as the P4 operand, they will be more readable.
drh8a512562005-11-14 22:29:05 +0000781**
782** Note also that the numeric types are grouped together so that testing
783** for a numeric type is a single comparison.
danielk1977a37cdde2004-05-16 11:15:36 +0000784*/
drh8a512562005-11-14 22:29:05 +0000785#define SQLITE_AFF_TEXT 'a'
786#define SQLITE_AFF_NONE 'b'
787#define SQLITE_AFF_NUMERIC 'c'
788#define SQLITE_AFF_INTEGER 'd'
789#define SQLITE_AFF_REAL 'e'
danielk1977a37cdde2004-05-16 11:15:36 +0000790
drh8a512562005-11-14 22:29:05 +0000791#define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC)
danielk1977a37cdde2004-05-16 11:15:36 +0000792
793/*
drh35573352008-01-08 23:54:25 +0000794** The SQLITE_AFF_MASK values masks off the significant bits of an
795** affinity value.
796*/
797#define SQLITE_AFF_MASK 0x67
798
799/*
800** Additional bit values that can be ORed with an affinity without
801** changing the affinity.
802*/
803#define SQLITE_JUMPIFNULL 0x08 /* jumps if either operand is NULL */
804#define SQLITE_NULLEQUAL 0x10 /* compare NULLs equal */
805#define SQLITE_STOREP2 0x80 /* Store result in reg[P2] rather than jump */
806
807/*
drh22f70c32002-02-18 01:17:00 +0000808** Each SQL table is represented in memory by an instance of the
809** following structure.
810**
drhd24cc422003-03-27 12:51:24 +0000811** Table.zName is the name of the table. The case of the original
drh22f70c32002-02-18 01:17:00 +0000812** CREATE TABLE statement is stored, but case is not significant for
813** comparisons.
814**
drhd24cc422003-03-27 12:51:24 +0000815** Table.nCol is the number of columns in this table. Table.aCol is a
drh22f70c32002-02-18 01:17:00 +0000816** pointer to an array of Column structures, one for each column.
817**
drhd24cc422003-03-27 12:51:24 +0000818** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
819** the column that is that key. Otherwise Table.iPKey is negative. Note
drh22f70c32002-02-18 01:17:00 +0000820** that the datatype of the PRIMARY KEY must be INTEGER for this field to
821** be set. An INTEGER PRIMARY KEY is used as the rowid for each row of
822** the table. If a table has no INTEGER PRIMARY KEY, then a random rowid
drhd24cc422003-03-27 12:51:24 +0000823** is generated for each row of the table. Table.hasPrimKey is true if
drh22f70c32002-02-18 01:17:00 +0000824** the table has any PRIMARY KEY, INTEGER or otherwise.
825**
drhd24cc422003-03-27 12:51:24 +0000826** Table.tnum is the page number for the root BTree page of the table in the
827** database file. If Table.iDb is the index of the database table backend
828** in sqlite.aDb[]. 0 is for the main database and 1 is for the file that
drhb9bb7c12006-06-11 23:41:55 +0000829** holds temporary tables and indices. If Table.isEphem
drh22f70c32002-02-18 01:17:00 +0000830** is true, then the table is stored in a file that is automatically deleted
drhd24cc422003-03-27 12:51:24 +0000831** when the VDBE cursor to the table is closed. In this case Table.tnum
drh22f70c32002-02-18 01:17:00 +0000832** refers VDBE cursor number that holds the table open, not to the root
833** page number. Transient tables are used to hold the results of a
834** sub-query that appears instead of a real table name in the FROM clause
835** of a SELECT statement.
drh75897232000-05-29 14:26:00 +0000836*/
837struct Table {
drh967e8b72000-06-21 13:59:10 +0000838 char *zName; /* Name of the table */
drh967e8b72000-06-21 13:59:10 +0000839 int nCol; /* Number of columns in this table */
840 Column *aCol; /* Information about each column */
drhc8392582001-12-31 02:48:51 +0000841 int iPKey; /* If not less then 0, use aCol[iPKey] as the primary key */
drh967e8b72000-06-21 13:59:10 +0000842 Index *pIndex; /* List of SQL indexes on this table. */
drh22f70c32002-02-18 01:17:00 +0000843 int tnum; /* Root BTree node for this table (see note above) */
drha76b5df2002-02-23 02:32:10 +0000844 Select *pSelect; /* NULL for tables. Points to definition if a view. */
drhed8a3bb2005-06-06 21:19:56 +0000845 int nRef; /* Number of pointers to this Table */
danielk1977c3f9bad2002-05-15 08:30:12 +0000846 Trigger *pTrigger; /* List of SQL triggers on this table */
drhc2eef3b2002-08-31 18:53:06 +0000847 FKey *pFKey; /* Linked list of all foreign keys in this table */
danielk19773d1bfea2004-05-14 11:00:53 +0000848 char *zColAff; /* String defining the affinity of each column */
drhffe07b22005-11-03 00:41:17 +0000849#ifndef SQLITE_OMIT_CHECK
850 Expr *pCheck; /* The AND of all CHECK constraints */
851#endif
danielk197719a8e7e2005-03-17 05:03:38 +0000852#ifndef SQLITE_OMIT_ALTERTABLE
853 int addColOffset; /* Offset in CREATE TABLE statement to add a new column */
854#endif
drh19146192006-06-26 19:10:32 +0000855 u8 readOnly; /* True if this table should not be written by the user */
856 u8 isEphem; /* True if created using OP_OpenEphermeral */
857 u8 hasPrimKey; /* True if there exists a primary key */
858 u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */
859 u8 autoInc; /* True if the integer primary key is autoincrement */
drhe09daa92006-06-10 13:29:31 +0000860#ifndef SQLITE_OMIT_VIRTUALTABLE
drh19146192006-06-26 19:10:32 +0000861 u8 isVirtual; /* True if this is a virtual table */
862 u8 isCommit; /* True once the CREATE TABLE has been committed */
danielk1977d1ab1ba2006-06-15 04:28:13 +0000863 Module *pMod; /* Pointer to the implementation of the module */
drhb9bb7c12006-06-11 23:41:55 +0000864 sqlite3_vtab *pVtab; /* Pointer to the module instance */
865 int nModuleArg; /* Number of arguments to the module */
866 char **azModuleArg; /* Text of all module args. [0] is module name */
drhe09daa92006-06-10 13:29:31 +0000867#endif
drh728b5772007-09-18 15:55:07 +0000868 Schema *pSchema; /* Schema that contains this table */
drh75897232000-05-29 14:26:00 +0000869};
870
871/*
drh4cbdda92006-06-14 19:00:20 +0000872** Test to see whether or not a table is a virtual table. This is
873** done as a macro so that it will be optimized out when virtual
874** table support is omitted from the build.
875*/
876#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977034ca142007-06-26 10:38:54 +0000877# define IsVirtual(X) ((X)->isVirtual)
878# define IsHiddenColumn(X) ((X)->isHidden)
drh4cbdda92006-06-14 19:00:20 +0000879#else
danielk1977034ca142007-06-26 10:38:54 +0000880# define IsVirtual(X) 0
881# define IsHiddenColumn(X) 0
drh4cbdda92006-06-14 19:00:20 +0000882#endif
883
884/*
drhc2eef3b2002-08-31 18:53:06 +0000885** Each foreign key constraint is an instance of the following structure.
886**
887** A foreign key is associated with two tables. The "from" table is
888** the table that contains the REFERENCES clause that creates the foreign
889** key. The "to" table is the table that is named in the REFERENCES clause.
890** Consider this example:
891**
892** CREATE TABLE ex1(
893** a INTEGER PRIMARY KEY,
894** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
895** );
896**
897** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
898**
899** Each REFERENCES clause generates an instance of the following structure
900** which is attached to the from-table. The to-table need not exist when
901** the from-table is created. The existance of the to-table is not checked
902** until an attempt is made to insert data into the from-table.
903**
drhea1ba172003-04-20 00:00:23 +0000904** The sqlite.aFKey hash table stores pointers to this structure
drhc2eef3b2002-08-31 18:53:06 +0000905** given the name of a to-table. For each to-table, all foreign keys
906** associated with that table are on a linked list using the FKey.pNextTo
907** field.
908*/
909struct FKey {
910 Table *pFrom; /* The table that constains the REFERENCES clause */
911 FKey *pNextFrom; /* Next foreign key in pFrom */
912 char *zTo; /* Name of table that the key points to */
913 FKey *pNextTo; /* Next foreign key that points to zTo */
914 int nCol; /* Number of columns in this key */
915 struct sColMap { /* Mapping of columns in pFrom to columns in zTo */
916 int iFrom; /* Index of column in pFrom */
917 char *zCol; /* Name of column in zTo. If 0 use PRIMARY KEY */
918 } *aCol; /* One entry for each of nCol column s */
919 u8 isDeferred; /* True if constraint checking is deferred till COMMIT */
920 u8 updateConf; /* How to resolve conflicts that occur on UPDATE */
921 u8 deleteConf; /* How to resolve conflicts that occur on DELETE */
922 u8 insertConf; /* How to resolve conflicts that occur on INSERT */
923};
924
925/*
danielk1977aaa40c12007-09-21 04:28:16 +0000926** SQLite supports many different ways to resolve a constraint
drh22f70c32002-02-18 01:17:00 +0000927** error. ROLLBACK processing means that a constraint violation
drh0bd1f4e2002-06-06 18:54:39 +0000928** causes the operation in process to fail and for the current transaction
drh1c928532002-01-31 15:54:21 +0000929** to be rolled back. ABORT processing means the operation in process
930** fails and any prior changes from that one operation are backed out,
931** but the transaction is not rolled back. FAIL processing means that
932** the operation in progress stops and returns an error code. But prior
933** changes due to the same operation are not backed out and no rollback
934** occurs. IGNORE means that the particular row that caused the constraint
935** error is not inserted or updated. Processing continues and no error
936** is returned. REPLACE means that preexisting database rows that caused
937** a UNIQUE constraint violation are removed so that the new insert or
938** update can proceed. Processing continues and no error is reported.
drhc2eef3b2002-08-31 18:53:06 +0000939**
940** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
941** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
942** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign
943** key is set to NULL. CASCADE means that a DELETE or UPDATE of the
944** referenced table row is propagated into the row that holds the
945** foreign key.
drh1c928532002-01-31 15:54:21 +0000946**
drh968af522003-02-11 14:55:40 +0000947** The following symbolic values are used to record which type
drh1c928532002-01-31 15:54:21 +0000948** of action to take.
drh9cfcf5d2002-01-29 18:41:24 +0000949*/
drh1c928532002-01-31 15:54:21 +0000950#define OE_None 0 /* There is no constraint to check */
951#define OE_Rollback 1 /* Fail the operation and rollback the transaction */
952#define OE_Abort 2 /* Back out changes but do no rollback transaction */
953#define OE_Fail 3 /* Stop the operation but leave all prior changes */
954#define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */
955#define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */
drhc2eef3b2002-08-31 18:53:06 +0000956
957#define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
958#define OE_SetNull 7 /* Set the foreign key value to NULL */
959#define OE_SetDflt 8 /* Set the foreign key value to its default */
960#define OE_Cascade 9 /* Cascade the changes */
961
962#define OE_Default 99 /* Do whatever the default action is */
drh9cfcf5d2002-01-29 18:41:24 +0000963
drhd3d39e92004-05-20 22:16:29 +0000964
965/*
966** An instance of the following structure is passed as the first
967** argument to sqlite3VdbeKeyCompare and is used to control the
968** comparison of the two index keys.
969**
970** If the KeyInfo.incrKey value is true and the comparison would
drh7e627792005-04-29 02:10:00 +0000971** otherwise be equal, then return a result as if the second key
972** were larger.
drhd3d39e92004-05-20 22:16:29 +0000973*/
974struct KeyInfo {
drhb21c8cd2007-08-21 19:33:56 +0000975 sqlite3 *db; /* The database connection */
danielk1977b1bc9532004-05-22 03:05:33 +0000976 u8 enc; /* Text encoding - one of the TEXT_Utf* values */
drhd3d39e92004-05-20 22:16:29 +0000977 u8 incrKey; /* Increase 2nd key by epsilon before comparison */
danielk19779a96b662007-11-29 17:05:18 +0000978 u8 prefixIsEqual; /* Treat a prefix as equal */
drhd3d39e92004-05-20 22:16:29 +0000979 int nField; /* Number of entries in aColl[] */
drhd2d4a6b2006-01-10 15:18:27 +0000980 u8 *aSortOrder; /* If defined an aSortOrder[i] is true, sort DESC */
drhd3d39e92004-05-20 22:16:29 +0000981 CollSeq *aColl[1]; /* Collating sequence for each term of the key */
982};
983
drh9cfcf5d2002-01-29 18:41:24 +0000984/*
drh66b89c82000-11-28 20:47:17 +0000985** Each SQL index is represented in memory by an
drh75897232000-05-29 14:26:00 +0000986** instance of the following structure.
drh967e8b72000-06-21 13:59:10 +0000987**
988** The columns of the table that are to be indexed are described
989** by the aiColumn[] field of this structure. For example, suppose
990** we have the following table and index:
991**
992** CREATE TABLE Ex1(c1 int, c2 int, c3 text);
993** CREATE INDEX Ex2 ON Ex1(c3,c1);
994**
995** In the Table structure describing Ex1, nCol==3 because there are
996** three columns in the table. In the Index structure describing
997** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
998** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the
999** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
1000** The second column to be indexed (c1) has an index of 0 in
1001** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
drhea1ba172003-04-20 00:00:23 +00001002**
1003** The Index.onError field determines whether or not the indexed columns
1004** must be unique and what to do if they are not. When Index.onError=OE_None,
1005** it means this is not a unique index. Otherwise it is a unique index
1006** and the value of Index.onError indicate the which conflict resolution
1007** algorithm to employ whenever an attempt is made to insert a non-unique
1008** element.
drh75897232000-05-29 14:26:00 +00001009*/
1010struct Index {
drh967e8b72000-06-21 13:59:10 +00001011 char *zName; /* Name of this index */
drh967e8b72000-06-21 13:59:10 +00001012 int nColumn; /* Number of columns in the table used by this index */
1013 int *aiColumn; /* Which columns are used by this index. 1st is 0 */
drh8b3d9902005-08-19 00:14:42 +00001014 unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
drh967e8b72000-06-21 13:59:10 +00001015 Table *pTable; /* The SQL table being indexed */
drhbe0072d2001-09-13 14:46:09 +00001016 int tnum; /* Page containing root of this index in database file */
drh9cfcf5d2002-01-29 18:41:24 +00001017 u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
drh485b39b2002-07-13 03:11:52 +00001018 u8 autoIndex; /* True if is automatically created (ex: by UNIQUE) */
danielk1977a37cdde2004-05-16 11:15:36 +00001019 char *zColAff; /* String defining the affinity of each column */
drh967e8b72000-06-21 13:59:10 +00001020 Index *pNext; /* The next index associated with the same table */
danielk1977b3bf5562006-01-10 17:58:23 +00001021 Schema *pSchema; /* Schema containing this index */
1022 u8 *aSortOrder; /* Array of size Index.nColumn. True==DESC, False==ASC */
1023 char **azColl; /* Array of collation sequence names for index */
drh75897232000-05-29 14:26:00 +00001024};
1025
1026/*
1027** Each token coming out of the lexer is an instance of
drh4b59ab52002-08-24 18:24:51 +00001028** this structure. Tokens are also used as part of an expression.
drh4efc4752004-01-16 15:55:37 +00001029**
1030** Note if Token.z==0 then Token.dyn and Token.n are undefined and
1031** may contain random values. Do not make any assuptions about Token.dyn
1032** and Token.n when Token.z==0.
drh75897232000-05-29 14:26:00 +00001033*/
1034struct Token {
drh4c755c02004-08-08 20:22:17 +00001035 const unsigned char *z; /* Text of the token. Not NULL-terminated! */
1036 unsigned dyn : 1; /* True for malloced memory, false for static */
1037 unsigned n : 31; /* Number of characters in this token */
drh75897232000-05-29 14:26:00 +00001038};
1039
1040/*
drh13449892005-09-07 21:22:45 +00001041** An instance of this structure contains information needed to generate
1042** code for a SELECT that contains aggregate functions.
1043**
1044** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
1045** pointer to this structure. The Expr.iColumn field is the index in
1046** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
1047** code for that node.
1048**
1049** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
1050** original Select structure that describes the SELECT statement. These
1051** fields do not need to be freed when deallocating the AggInfo structure.
1052*/
1053struct AggInfo {
1054 u8 directMode; /* Direct rendering mode means take data directly
1055 ** from source tables rather than from accumulators */
1056 u8 useSortingIdx; /* In direct mode, reference the sorting index rather
1057 ** than the source table */
1058 int sortingIdx; /* Cursor number of the sorting index */
1059 ExprList *pGroupBy; /* The group by clause */
1060 int nSortingColumn; /* Number of columns in the sorting index */
1061 struct AggInfo_col { /* For each column used in source tables */
danielk19770817d0d2007-02-14 09:19:36 +00001062 Table *pTab; /* Source table */
drh13449892005-09-07 21:22:45 +00001063 int iTable; /* Cursor number of the source table */
1064 int iColumn; /* Column number within the source table */
1065 int iSorterColumn; /* Column number in the sorting index */
1066 int iMem; /* Memory location that acts as accumulator */
drh5774b802005-09-07 22:48:16 +00001067 Expr *pExpr; /* The original expression */
drh13449892005-09-07 21:22:45 +00001068 } *aCol;
1069 int nColumn; /* Number of used entries in aCol[] */
1070 int nColumnAlloc; /* Number of slots allocated for aCol[] */
1071 int nAccumulator; /* Number of columns that show through to the output.
1072 ** Additional columns are used only as parameters to
1073 ** aggregate functions */
1074 struct AggInfo_func { /* For each aggregate function */
1075 Expr *pExpr; /* Expression encoding the function */
1076 FuncDef *pFunc; /* The aggregate function implementation */
1077 int iMem; /* Memory location that acts as accumulator */
drhb9bb7c12006-06-11 23:41:55 +00001078 int iDistinct; /* Ephermeral table used to enforce DISTINCT */
drh13449892005-09-07 21:22:45 +00001079 } *aFunc;
1080 int nFunc; /* Number of entries in aFunc[] */
1081 int nFuncAlloc; /* Number of slots allocated for aFunc[] */
1082};
1083
1084/*
drh75897232000-05-29 14:26:00 +00001085** Each node of an expression in the parse tree is an instance
drh22f70c32002-02-18 01:17:00 +00001086** of this structure.
1087**
1088** Expr.op is the opcode. The integer parser token codes are reused
1089** as opcodes here. For example, the parser defines TK_GE to be an integer
1090** code representing the ">=" operator. This same integer code is reused
1091** to represent the greater-than-or-equal-to operator in the expression
1092** tree.
1093**
1094** Expr.pRight and Expr.pLeft are subexpressions. Expr.pList is a list
1095** of argument if the expression is a function.
1096**
drh4b59ab52002-08-24 18:24:51 +00001097** Expr.token is the operator token for this node. For some expressions
1098** that have subexpressions, Expr.token can be the complete text that gave
1099** rise to the Expr. In the latter case, the token is marked as being
1100** a compound token.
drh22f70c32002-02-18 01:17:00 +00001101**
1102** An expression of the form ID or ID.ID refers to a column in a table.
1103** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
1104** the integer cursor number of a VDBE cursor pointing to that table and
1105** Expr.iColumn is the column number for the specific column. If the
1106** expression is used as a result in an aggregate SELECT, then the
1107** value is also stored in the Expr.iAgg column in the aggregate so that
1108** it can be accessed after all aggregates are computed.
1109**
1110** If the expression is a function, the Expr.iTable is an integer code
drh7c972de2003-09-06 22:18:07 +00001111** representing which function. If the expression is an unbound variable
1112** marker (a question mark character '?' in the original SQL) then the
1113** Expr.iTable holds the index number for that variable.
drh22f70c32002-02-18 01:17:00 +00001114**
drh1398ad32005-01-19 23:24:50 +00001115** If the expression is a subquery then Expr.iColumn holds an integer
1116** register number containing the result of the subquery. If the
1117** subquery gives a constant result, then iTable is -1. If the subquery
1118** gives a different answer at different times during statement processing
1119** then iTable is the address of a subroutine that computes the subquery.
1120**
drh22f70c32002-02-18 01:17:00 +00001121** The Expr.pSelect field points to a SELECT statement. The SELECT might
1122** be the right operand of an IN operator. Or, if a scalar SELECT appears
1123** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
1124** operand.
danielk1977aee18ef2005-03-09 12:26:50 +00001125**
1126** If the Expr is of type OP_Column, and the table it is selecting from
1127** is a disk table or the "old.*" pseudo-table, then pTab points to the
1128** corresponding table definition.
drh75897232000-05-29 14:26:00 +00001129*/
1130struct Expr {
drh1cc093c2002-06-24 22:01:57 +00001131 u8 op; /* Operation performed by this node */
drha9fd84b2004-05-18 23:21:35 +00001132 char affinity; /* The affinity of the column or 0 if not a column */
drh6a03a1c2006-07-08 18:34:59 +00001133 u16 flags; /* Various flags. See below */
drhf2bc0132004-10-04 13:19:23 +00001134 CollSeq *pColl; /* The collation type of the column or 0 */
drh75897232000-05-29 14:26:00 +00001135 Expr *pLeft, *pRight; /* Left and right subnodes */
drhd99f7062002-06-08 23:25:08 +00001136 ExprList *pList; /* A list of expressions used as function arguments
1137 ** or in "<expr> IN (<expr-list)" */
drh75897232000-05-29 14:26:00 +00001138 Token token; /* An operand token */
drh6977fea2002-10-22 23:38:04 +00001139 Token span; /* Complete text of the expression */
drh967e8b72000-06-21 13:59:10 +00001140 int iTable, iColumn; /* When op==TK_COLUMN, then this expr node means the
drh8e2ca022002-06-17 17:07:19 +00001141 ** iColumn-th field of the iTable-th table. */
drh13449892005-09-07 21:22:45 +00001142 AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
1143 int iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
drh22d6a532005-09-19 21:05:48 +00001144 int iRightJoinTable; /* If EP_FromJoin, the right table of the join */
drhd99f7062002-06-08 23:25:08 +00001145 Select *pSelect; /* When the expression is a sub-select. Also the
1146 ** right side of "<expr> IN (<select>)" */
danielk1977aee18ef2005-03-09 12:26:50 +00001147 Table *pTab; /* Table for OP_Column expressions. */
drh728b5772007-09-18 15:55:07 +00001148/* Schema *pSchema; */
danielk1977e6a58a42007-08-31 17:42:48 +00001149#if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
danielk1977fc976062007-05-10 10:46:56 +00001150 int nHeight; /* Height of the tree headed by this node */
1151#endif
drh75897232000-05-29 14:26:00 +00001152};
1153
1154/*
drh1f162302002-10-27 19:35:33 +00001155** The following are the meanings of bits in the Expr.flags field.
1156*/
drh678ccce2008-03-31 18:19:54 +00001157#define EP_FromJoin 0x0001 /* Originated in ON or USING clause of a join */
1158#define EP_Agg 0x0002 /* Contains one or more aggregate functions */
1159#define EP_Resolved 0x0004 /* IDs have been resolved to COLUMNs */
1160#define EP_Error 0x0008 /* Expression contains one or more errors */
1161#define EP_Distinct 0x0010 /* Aggregate function with DISTINCT keyword */
1162#define EP_VarSelect 0x0020 /* pSelect is correlated, not constant */
1163#define EP_Dequoted 0x0040 /* True if the string has been dequoted */
1164#define EP_InfixFunc 0x0080 /* True for an infix function: LIKE, GLOB, etc */
1165#define EP_ExpCollate 0x0100 /* Collating sequence specified explicitly */
drhda250ea2008-04-01 05:07:14 +00001166#define EP_AnyAff 0x0200 /* Can take a cached column of any affinity */
drh47de9552008-04-01 18:04:11 +00001167#define EP_FixedDest 0x0400 /* Result needed in a specific register */
drh1f162302002-10-27 19:35:33 +00001168
1169/*
1170** These macros can be used to test, set, or clear bits in the
1171** Expr.flags field.
1172*/
1173#define ExprHasProperty(E,P) (((E)->flags&(P))==(P))
1174#define ExprHasAnyProperty(E,P) (((E)->flags&(P))!=0)
1175#define ExprSetProperty(E,P) (E)->flags|=(P)
1176#define ExprClearProperty(E,P) (E)->flags&=~(P)
1177
1178/*
drh75897232000-05-29 14:26:00 +00001179** A list of expressions. Each expression may optionally have a
1180** name. An expr/name combination can be used in several ways, such
1181** as the list of "expr AS ID" fields following a "SELECT" or in the
1182** list of "ID = expr" items in an UPDATE. A list of expressions can
drhad3cab52002-05-24 02:04:32 +00001183** also be used as the argument to a function, in which case the a.zName
drh75897232000-05-29 14:26:00 +00001184** field is not used.
1185*/
1186struct ExprList {
1187 int nExpr; /* Number of expressions on the list */
drh4305d102003-07-30 12:34:12 +00001188 int nAlloc; /* Number of entries allocated below */
drh9d2985c2005-09-08 01:58:42 +00001189 int iECursor; /* VDBE Cursor associated with this ExprList */
drh6d4abfb2001-10-22 02:58:08 +00001190 struct ExprList_item {
drh75897232000-05-29 14:26:00 +00001191 Expr *pExpr; /* The list of expressions */
1192 char *zName; /* Token associated with this expression */
drh8e2ca022002-06-17 17:07:19 +00001193 u8 sortOrder; /* 1 for DESC or 0 for ASC */
1194 u8 isAgg; /* True if this is an aggregate like count(*) */
1195 u8 done; /* A flag to indicate when processing is finished */
drh75897232000-05-29 14:26:00 +00001196 } *a; /* One entry for each expression */
1197};
1198
1199/*
drhad3cab52002-05-24 02:04:32 +00001200** An instance of this structure can hold a simple list of identifiers,
1201** such as the list "a,b,c" in the following statements:
1202**
1203** INSERT INTO t(a,b,c) VALUES ...;
1204** CREATE INDEX idx ON t(a,b,c);
1205** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1206**
1207** The IdList.a.idx field is used when the IdList represents the list of
1208** column names after a table name in an INSERT statement. In the statement
1209**
1210** INSERT INTO t(a,b,c) ...
1211**
1212** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
drh75897232000-05-29 14:26:00 +00001213*/
1214struct IdList {
drh6d4abfb2001-10-22 02:58:08 +00001215 struct IdList_item {
drhad3cab52002-05-24 02:04:32 +00001216 char *zName; /* Name of the identifier */
drh967e8b72000-06-21 13:59:10 +00001217 int idx; /* Index in some Table.aCol[] of a column named zName */
drhad3cab52002-05-24 02:04:32 +00001218 } *a;
drh13449892005-09-07 21:22:45 +00001219 int nId; /* Number of identifiers on the list */
1220 int nAlloc; /* Number of entries allocated for a[] below */
drhad3cab52002-05-24 02:04:32 +00001221};
1222
1223/*
drh51669862004-12-18 18:40:26 +00001224** The bitmask datatype defined below is used for various optimizations.
drhca83ac52007-02-01 01:40:44 +00001225**
1226** Changing this from a 64-bit to a 32-bit type limits the number of
1227** tables in a join to 32 instead of 64. But it also reduces the size
1228** of the library by 738 bytes on ix86.
drh51669862004-12-18 18:40:26 +00001229*/
drhca83ac52007-02-01 01:40:44 +00001230typedef u64 Bitmask;
drh51669862004-12-18 18:40:26 +00001231
1232/*
drhad3cab52002-05-24 02:04:32 +00001233** The following structure describes the FROM clause of a SELECT statement.
1234** Each table or subquery in the FROM clause is a separate element of
1235** the SrcList.a[] array.
drhd24cc422003-03-27 12:51:24 +00001236**
1237** With the addition of multiple database support, the following structure
1238** can also be used to describe a particular table such as the table that
1239** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL,
1240** such a table must be a simple name: ID. But in SQLite, the table can
1241** now be identified by a database name, a dot, then the table name: ID.ID.
drhc49de5d2007-01-19 01:06:01 +00001242**
1243** The jointype starts out showing the join type between the current table
1244** and the next table on the list. The parser builds the list this way.
1245** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
1246** jointype expresses the join between the table and the previous table.
drhad3cab52002-05-24 02:04:32 +00001247*/
1248struct SrcList {
drh939a16d2004-07-15 13:37:22 +00001249 i16 nSrc; /* Number of tables or subqueries in the FROM clause */
1250 i16 nAlloc; /* Number of entries allocated in a[] below */
drhad3cab52002-05-24 02:04:32 +00001251 struct SrcList_item {
drh113088e2003-03-20 01:16:58 +00001252 char *zDatabase; /* Name of database holding this table */
drhad3cab52002-05-24 02:04:32 +00001253 char *zName; /* Name of the table */
1254 char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */
drhdaffd0e2001-04-11 14:28:42 +00001255 Table *pTab; /* An SQL table corresponding to zName */
1256 Select *pSelect; /* A SELECT statement used in place of a table name */
danielk19771787cca2006-02-10 07:07:14 +00001257 u8 isPopulated; /* Temporary table associated with SELECT is populated */
drhc49de5d2007-01-19 01:06:01 +00001258 u8 jointype; /* Type of join between this able and the previous */
drhe68fbe72007-02-13 12:49:24 +00001259 int iCursor; /* The VDBE cursor number used to access this table */
drhad3cab52002-05-24 02:04:32 +00001260 Expr *pOn; /* The ON clause of a join */
1261 IdList *pUsing; /* The USING clause of a join */
drh51669862004-12-18 18:40:26 +00001262 Bitmask colUsed; /* Bit N (1<<N) set if column N or pTab is used */
drh113088e2003-03-20 01:16:58 +00001263 } a[1]; /* One entry for each identifier on the list */
drh75897232000-05-29 14:26:00 +00001264};
1265
1266/*
drh01f3f252002-05-24 16:14:15 +00001267** Permitted values of the SrcList.a.jointype field
1268*/
1269#define JT_INNER 0x0001 /* Any kind of inner or cross join */
drh3dec2232005-09-10 15:28:09 +00001270#define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */
1271#define JT_NATURAL 0x0004 /* True for a "natural" join */
1272#define JT_LEFT 0x0008 /* Left outer join */
1273#define JT_RIGHT 0x0010 /* Right outer join */
1274#define JT_OUTER 0x0020 /* The "OUTER" keyword is present */
1275#define JT_ERROR 0x0040 /* unknown or unsupported join type */
drh01f3f252002-05-24 16:14:15 +00001276
1277/*
drh6b563442001-11-07 16:48:26 +00001278** For each nested loop in a WHERE clause implementation, the WhereInfo
1279** structure contains a single instance of this structure. This structure
1280** is intended to be private the the where.c module and should not be
1281** access or modified by other modules.
drh6d209d82006-06-27 01:54:26 +00001282**
1283** The pIdxInfo and pBestIdx fields are used to help pick the best
1284** index on a virtual table. The pIdxInfo pointer contains indexing
1285** information for the i-th table in the FROM clause before reordering.
1286** All the pIdxInfo pointers are freed by whereInfoFree() in where.c.
1287** The pBestIdx pointer is a copy of pIdxInfo for the i-th table after
1288** FROM clause ordering. This is a little confusing so I will repeat
1289** it in different words. WhereInfo.a[i].pIdxInfo is index information
1290** for WhereInfo.pTabList.a[i]. WhereInfo.a[i].pBestInfo is the
1291** index information for the i-th loop of the join. pBestInfo is always
1292** either NULL or a copy of some pIdxInfo. So for cleanup it is
1293** sufficient to free all of the pIdxInfo pointers.
1294**
drh6b563442001-11-07 16:48:26 +00001295*/
1296struct WhereLevel {
drh29dda4a2005-07-21 18:23:20 +00001297 int iFrom; /* Which entry in the FROM clause */
1298 int flags; /* Flags associated with this level */
drh51147ba2005-07-23 22:59:55 +00001299 int iMem; /* First memory cell used by this level */
drh29dda4a2005-07-21 18:23:20 +00001300 int iLeftJoin; /* Memory cell used to implement LEFT OUTER JOIN */
1301 Index *pIdx; /* Index used. NULL if no index */
1302 int iTabCur; /* The VDBE cursor used to access the table */
1303 int iIdxCur; /* The VDBE cursor used to acesss pIdx */
1304 int brk; /* Jump here to break out of the loop */
drh72e8fa42007-03-28 14:30:06 +00001305 int nxt; /* Jump here to start the next IN combination */
drh29dda4a2005-07-21 18:23:20 +00001306 int cont; /* Jump here to continue with the next loop cycle */
1307 int top; /* First instruction of interior of the loop */
1308 int op, p1, p2; /* Opcode used to terminate the loop */
drh51147ba2005-07-23 22:59:55 +00001309 int nEq; /* Number of == or IN constraints on this loop */
drhe23399f2005-07-22 00:31:39 +00001310 int nIn; /* Number of IN operators constraining this loop */
drh72e8fa42007-03-28 14:30:06 +00001311 struct InLoop {
1312 int iCur; /* The VDBE cursor used by this IN operator */
1313 int topAddr; /* Top of the IN loop */
1314 } *aInLoop; /* Information about each nested IN operator */
drh6d209d82006-06-27 01:54:26 +00001315 sqlite3_index_info *pBestIdx; /* Index information for this level */
1316
1317 /* The following field is really not part of the current level. But
1318 ** we need a place to cache index information for each table in the
1319 ** FROM clause and the WhereLevel structure is a convenient place.
1320 */
1321 sqlite3_index_info *pIdxInfo; /* Index info for n-th source table */
drh6b563442001-11-07 16:48:26 +00001322};
1323
drh08c88eb2008-04-10 13:33:18 +00001324/*
1325** Flags appropriate for the wflags parameter of sqlite3WhereBegin().
1326*/
1327#define WHERE_ORDERBY_NORMAL 0 /* No-op */
1328#define WHERE_ORDERBY_MIN 1 /* ORDER BY processing for min() func */
1329#define WHERE_ORDERBY_MAX 2 /* ORDER BY processing for max() func */
1330#define WHERE_ONEPASS_DESIRED 4 /* Want to do one-pass UPDATE/DELETE */
danielk1977a9d1ccb2008-01-05 17:39:29 +00001331
drh6b563442001-11-07 16:48:26 +00001332/*
drh75897232000-05-29 14:26:00 +00001333** The WHERE clause processing routine has two halves. The
1334** first part does the start of the WHERE loop and the second
1335** half does the tail of the WHERE loop. An instance of
1336** this structure is returned by the first half and passed
1337** into the second half to give some continuity.
1338*/
1339struct WhereInfo {
drh08c88eb2008-04-10 13:33:18 +00001340 Parse *pParse; /* Parsing and code generating context */
1341 u8 okOnePass; /* Ok to use one-pass algorithm for UPDATE or DELETE */
drhad3cab52002-05-24 02:04:32 +00001342 SrcList *pTabList; /* List of tables in the join */
drh9012bcb2004-12-19 00:11:35 +00001343 int iTop; /* The very beginning of the WHERE loop */
drh19a775c2000-06-05 18:54:46 +00001344 int iContinue; /* Jump here to continue with next record */
1345 int iBreak; /* Jump here to break out of the loop */
drh6b563442001-11-07 16:48:26 +00001346 int nLevel; /* Number of nested loop */
drh6d209d82006-06-27 01:54:26 +00001347 sqlite3_index_info **apInfo; /* Array of pointers to index info structures */
drh6b563442001-11-07 16:48:26 +00001348 WhereLevel a[1]; /* Information about each nest loop in the WHERE */
drh75897232000-05-29 14:26:00 +00001349};
1350
1351/*
danielk1977b3bce662005-01-29 08:32:43 +00001352** A NameContext defines a context in which to resolve table and column
1353** names. The context consists of a list of tables (the pSrcList) field and
1354** a list of named expression (pEList). The named expression list may
1355** be NULL. The pSrc corresponds to the FROM clause of a SELECT or
1356** to the table being operated on by INSERT, UPDATE, or DELETE. The
1357** pEList corresponds to the result set of a SELECT and is NULL for
1358** other statements.
1359**
1360** NameContexts can be nested. When resolving names, the inner-most
1361** context is searched first. If no match is found, the next outer
1362** context is checked. If there is still no match, the next context
1363** is checked. This process continues until either a match is found
1364** or all contexts are check. When a match is found, the nRef member of
1365** the context containing the match is incremented.
1366**
1367** Each subquery gets a new NameContext. The pNext field points to the
1368** NameContext in the parent query. Thus the process of scanning the
1369** NameContext list corresponds to searching through successively outer
1370** subqueries looking for a match.
1371*/
1372struct NameContext {
1373 Parse *pParse; /* The parser */
1374 SrcList *pSrcList; /* One or more tables used to resolve names */
1375 ExprList *pEList; /* Optional list of named expressions */
1376 int nRef; /* Number of names resolved by this context */
1377 int nErr; /* Number of errors encountered while resolving names */
1378 u8 allowAgg; /* Aggregate functions allowed here */
drh13449892005-09-07 21:22:45 +00001379 u8 hasAgg; /* True if aggregates are seen */
drh06f65412005-11-03 02:03:13 +00001380 u8 isCheck; /* True if resolving names in a CHECK constraint */
danielk1977b3bce662005-01-29 08:32:43 +00001381 int nDepth; /* Depth of subquery recursion. 1 for no recursion */
drh13449892005-09-07 21:22:45 +00001382 AggInfo *pAggInfo; /* Information about aggregates at this level */
danielk1977b3bce662005-01-29 08:32:43 +00001383 NameContext *pNext; /* Next outer name context. NULL for outermost */
1384};
1385
1386/*
drh9bb61fe2000-06-05 16:01:39 +00001387** An instance of the following structure contains all information
1388** needed to generate code for a single SELECT statement.
drha76b5df2002-02-23 02:32:10 +00001389**
drhd11d3822002-06-21 23:01:49 +00001390** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0.
1391** If there is a LIMIT clause, the parser sets nLimit to the value of the
1392** limit and nOffset to the value of the offset (or 0 if there is not
1393** offset). But later on, nLimit and nOffset become the memory locations
1394** in the VDBE that record the limit and offset counters.
drh0342b1f2005-09-01 03:07:44 +00001395**
drhb9bb7c12006-06-11 23:41:55 +00001396** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
drh0342b1f2005-09-01 03:07:44 +00001397** These addresses must be stored so that we can go back and fill in
drh66a51672008-01-03 00:01:23 +00001398** the P4_KEYINFO and P2 parameters later. Neither the KeyInfo nor
drh0342b1f2005-09-01 03:07:44 +00001399** the number of columns in P2 can be computed at the same time
drhb9bb7c12006-06-11 23:41:55 +00001400** as the OP_OpenEphm instruction is coded because not
drh0342b1f2005-09-01 03:07:44 +00001401** enough information about the compound query is known at that point.
drhb9bb7c12006-06-11 23:41:55 +00001402** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
1403** for the result set. The KeyInfo for addrOpenTran[2] contains collating
drh0342b1f2005-09-01 03:07:44 +00001404** sequences for the ORDER BY clause.
drh9bb61fe2000-06-05 16:01:39 +00001405*/
1406struct Select {
drh9bb61fe2000-06-05 16:01:39 +00001407 ExprList *pEList; /* The fields of the result */
drh7b58dae2003-07-20 01:16:46 +00001408 u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
1409 u8 isDistinct; /* True if the DISTINCT keyword is present */
drh0342b1f2005-09-01 03:07:44 +00001410 u8 isResolved; /* True once sqlite3SelectResolve() has run. */
1411 u8 isAgg; /* True if this is an aggregate query */
drhb9bb7c12006-06-11 23:41:55 +00001412 u8 usesEphm; /* True if uses an OpenEphemeral opcode */
drh4b14b4d2005-09-19 17:35:53 +00001413 u8 disallowOrderBy; /* Do not allow an ORDER BY to be attached if TRUE */
drh6c1426f2007-04-12 03:54:38 +00001414 char affinity; /* MakeRecord with this affinity for SRT_Set */
drhad3cab52002-05-24 02:04:32 +00001415 SrcList *pSrc; /* The FROM clause */
drh9bb61fe2000-06-05 16:01:39 +00001416 Expr *pWhere; /* The WHERE clause */
1417 ExprList *pGroupBy; /* The GROUP BY clause */
1418 Expr *pHaving; /* The HAVING clause */
1419 ExprList *pOrderBy; /* The ORDER BY clause */
drh967e8b72000-06-21 13:59:10 +00001420 Select *pPrior; /* Prior select in a compound select statement */
drh1e281292007-12-13 03:45:07 +00001421 Select *pNext; /* Next select to the left in a compound */
drh0342b1f2005-09-01 03:07:44 +00001422 Select *pRightmost; /* Right-most select in a compound select statement */
danielk1977a2dc3b12005-02-05 12:48:48 +00001423 Expr *pLimit; /* LIMIT expression. NULL means not used. */
1424 Expr *pOffset; /* OFFSET expression. NULL means not used. */
drh7b58dae2003-07-20 01:16:46 +00001425 int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */
drhb9bb7c12006-06-11 23:41:55 +00001426 int addrOpenEphm[3]; /* OP_OpenEphem opcodes related to this select */
drh9bb61fe2000-06-05 16:01:39 +00001427};
1428
1429/*
drhfef52082000-06-06 01:50:43 +00001430** The results of a select can be distributed in several ways.
1431*/
drh13449892005-09-07 21:22:45 +00001432#define SRT_Union 1 /* Store result as keys in an index */
1433#define SRT_Except 2 /* Remove result from a UNION index */
danielk19779ed1dfa2008-01-02 17:11:14 +00001434#define SRT_Exists 3 /* Store 1 if the result is not empty */
1435#define SRT_Discard 4 /* Do not save the results anywhere */
drhfef52082000-06-06 01:50:43 +00001436
drh13449892005-09-07 21:22:45 +00001437/* The ORDER BY clause is ignored for all of the above */
danielk19776c8c8ce2008-01-02 16:27:09 +00001438#define IgnorableOrderby(X) ((X->eDest)<=SRT_Discard)
drh13449892005-09-07 21:22:45 +00001439
danielk19779ed1dfa2008-01-02 17:11:14 +00001440#define SRT_Callback 5 /* Invoke a callback with each row of result */
1441#define SRT_Mem 6 /* Store result in a memory cell */
1442#define SRT_Set 7 /* Store non-null results as keys in an index */
1443#define SRT_Table 8 /* Store result as data with an automatic rowid */
1444#define SRT_EphemTab 9 /* Create transient tab and store like SRT_Table */
1445#define SRT_Subroutine 10 /* Call a subroutine to handle results */
drh22827922000-06-06 17:27:05 +00001446
1447/*
danielk19776c8c8ce2008-01-02 16:27:09 +00001448** A structure used to customize the behaviour of sqlite3Select(). See
1449** comments above sqlite3Select() for details.
1450*/
1451typedef struct SelectDest SelectDest;
1452struct SelectDest {
drh477df4b2008-01-05 18:48:24 +00001453 u8 eDest; /* How to dispose of the results */
1454 u8 affinity; /* Affinity used when eDest==SRT_Set */
danielk19776c8c8ce2008-01-02 16:27:09 +00001455 int iParm; /* A parameter used by the eDest disposal method */
drh1013c932008-01-06 00:25:21 +00001456 int iMem; /* Base register where results are written */
drhad27e762008-03-26 12:46:23 +00001457 int nMem; /* Number of registers allocated */
danielk19776c8c8ce2008-01-02 16:27:09 +00001458};
1459
1460/*
drhf57b3392001-10-08 13:22:32 +00001461** An SQL parser context. A copy of this structure is passed through
1462** the parser and down into all the parser action routine in order to
1463** carry around information that is global to the entire parse.
drhf1974842004-11-05 03:56:00 +00001464**
1465** The structure is divided into two parts. When the parser and code
1466** generate call themselves recursively, the first part of the structure
1467** is constant but the second part is reset at the beginning and end of
1468** each recursion.
danielk1977c00da102006-01-07 13:21:04 +00001469**
1470** The nTableLock and aTableLock variables are only used if the shared-cache
1471** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
1472** used to store the set of table-locks required by the statement being
1473** compiled. Function sqlite3TableLock() is used to add entries to the
1474** list.
drh75897232000-05-29 14:26:00 +00001475*/
1476struct Parse {
drh9bb575f2004-09-06 17:24:11 +00001477 sqlite3 *db; /* The main database structure */
drh4c504392000-10-16 22:06:40 +00001478 int rc; /* Return code from execution */
drh75897232000-05-29 14:26:00 +00001479 char *zErrMsg; /* An error message */
drh75897232000-05-29 14:26:00 +00001480 Vdbe *pVdbe; /* An engine for executing database bytecode */
drh836faa42003-01-11 13:30:57 +00001481 u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */
drhe0bc4042002-06-25 01:09:11 +00001482 u8 nameClash; /* A permanent table name clashes with temp table name */
drha6ecd332004-06-10 00:29:09 +00001483 u8 checkSchema; /* Causes schema cookie check after an error */
drh205f48e2004-11-05 00:43:11 +00001484 u8 nested; /* Number of nested calls to the parser/code generator */
drh7e326c02007-05-15 16:51:37 +00001485 u8 parseError; /* True after a parsing error. Ticket #1794 */
drh892d3172008-01-10 03:46:36 +00001486 u8 nTempReg; /* Number of temporary registers in aTempReg[] */
drh2dcef112008-01-12 19:03:48 +00001487 u8 nTempInUse; /* Number of aTempReg[] currently checked out */
drh892d3172008-01-10 03:46:36 +00001488 int aTempReg[8]; /* Holding area for temporary registers */
1489 int nRangeReg; /* Size of the temporary register block */
1490 int iRangeReg; /* First register in temporary register block */
drh75897232000-05-29 14:26:00 +00001491 int nErr; /* Number of errors seen */
drh832508b2002-03-02 17:04:07 +00001492 int nTab; /* Number of previously allocated VDBE cursors */
drh19a775c2000-06-05 18:54:46 +00001493 int nMem; /* Number of memory cells used so far */
drhfef52082000-06-06 01:50:43 +00001494 int nSet; /* Number of sets used so far */
drhaa9b8962008-01-08 02:57:55 +00001495 int ckBase; /* Base register of data during check constraints */
drhe55cbd72008-03-31 23:48:03 +00001496 int disableColCache; /* True to disable adding to column cache */
1497 int nColCache; /* Number of entries in the column cache */
1498 int iColCache; /* Next entry of the cache to replace */
drh2f7794c2008-04-01 03:27:39 +00001499 struct yColCache {
drhe55cbd72008-03-31 23:48:03 +00001500 int iTable; /* Table cursor number */
1501 int iColumn; /* Table column number */
drhda250ea2008-04-01 05:07:14 +00001502 char affChange; /* True if this register has had an affinity change */
drhe55cbd72008-03-31 23:48:03 +00001503 int iReg; /* Register holding value of this column */
1504 } aColCache[10]; /* One for each valid column cache entry */
drh80242052004-06-09 00:48:12 +00001505 u32 writeMask; /* Start a write transaction on these databases */
drhfcd35c72005-05-21 02:48:08 +00001506 u32 cookieMask; /* Bitmask of schema verified databases */
1507 int cookieGoto; /* Address of OP_Goto to cookie verifier subroutine */
drhc797d4d2007-05-08 01:08:49 +00001508 int cookieValue[SQLITE_MAX_ATTACHED+2]; /* Values of cookies to verify */
danielk1977c00da102006-01-07 13:21:04 +00001509#ifndef SQLITE_OMIT_SHARED_CACHE
1510 int nTableLock; /* Number of locks in aTableLock */
1511 TableLock *aTableLock; /* Required table locks for shared-cache mode */
1512#endif
danielk1977cac336a2008-03-08 06:16:29 +00001513 int regRowid; /* Register holding rowid of CREATE TABLE entry */
1514 int regRoot; /* Register holding root page number for new objects */
drhf1974842004-11-05 03:56:00 +00001515
1516 /* Above is constant between recursions. Below is reset before and after
1517 ** each recursion */
1518
1519 int nVar; /* Number of '?' variables seen in the SQL so far */
1520 int nVarExpr; /* Number of used slots in apVarExpr[] */
1521 int nVarExprAlloc; /* Number of allocated slots in apVarExpr[] */
1522 Expr **apVarExpr; /* Pointers to :aaa and $aaaa wildcard expressions */
1523 u8 explain; /* True if the EXPLAIN flag is found on the query */
drhf1974842004-11-05 03:56:00 +00001524 Token sErrToken; /* The token at which the error occurred */
1525 Token sNameToken; /* Token with unqualified schema object name */
1526 Token sLastToken; /* The last token parsed */
1527 const char *zSql; /* All SQL text */
1528 const char *zTail; /* All SQL text past the last semicolon parsed */
1529 Table *pNewTable; /* A table being constructed by CREATE TABLE */
1530 Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */
1531 TriggerStack *trigStack; /* Trigger actions being coded */
1532 const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
drhb9bb7c12006-06-11 23:41:55 +00001533#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk197733b39332006-06-24 08:51:05 +00001534 Token sArg; /* Complete text of a module argument */
danielk1977f9e7dda2006-06-16 16:08:53 +00001535 u8 declareVtab; /* True if inside sqlite3_declare_vtab() */
1536 Table *pVirtualLock; /* Require virtual table lock on this table */
drhb9bb7c12006-06-11 23:41:55 +00001537#endif
danielk1977e6a58a42007-08-31 17:42:48 +00001538#if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
danielk1977fc976062007-05-10 10:46:56 +00001539 int nHeight; /* Expression tree height of current sub-select */
1540#endif
drh75897232000-05-29 14:26:00 +00001541};
1542
danielk19777e6ebfb2006-06-12 11:24:37 +00001543#ifdef SQLITE_OMIT_VIRTUALTABLE
1544 #define IN_DECLARE_VTAB 0
1545#else
1546 #define IN_DECLARE_VTAB (pParse->declareVtab)
1547#endif
1548
danielk1977d99bc932002-05-16 00:13:12 +00001549/*
drh85e20962003-04-25 17:52:11 +00001550** An instance of the following structure can be declared on a stack and used
1551** to save the Parse.zAuthContext value so that it can be restored later.
1552*/
1553struct AuthContext {
1554 const char *zAuthContext; /* Put saved Parse.zAuthContext here */
1555 Parse *pParse; /* The Parse structure */
1556};
1557
1558/*
drhf0863fe2005-06-12 21:35:51 +00001559** Bitfield flags for P2 value in OP_Insert and OP_Delete
rdcb0c374f2004-02-20 22:53:38 +00001560*/
1561#define OPFLAG_NCHANGE 1 /* Set to update db->nChange */
1562#define OPFLAG_LASTROWID 2 /* Set to update db->lastRowid */
danielk197794eb6a12005-12-15 15:22:08 +00001563#define OPFLAG_ISUPDATE 4 /* This OP_Insert is an sql UPDATE */
drhe4d90812007-03-29 05:51:49 +00001564#define OPFLAG_APPEND 8 /* This is likely to be an append */
rdcb0c374f2004-02-20 22:53:38 +00001565
1566/*
danielk1977d99bc932002-05-16 00:13:12 +00001567 * Each trigger present in the database schema is stored as an instance of
1568 * struct Trigger.
1569 *
1570 * Pointers to instances of struct Trigger are stored in two ways.
drh9bb575f2004-09-06 17:24:11 +00001571 * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
danielk1977d99bc932002-05-16 00:13:12 +00001572 * database). This allows Trigger structures to be retrieved by name.
1573 * 2. All triggers associated with a single table form a linked list, using the
drhad3cab52002-05-24 02:04:32 +00001574 * pNext member of struct Trigger. A pointer to the first element of the
1575 * linked list is stored as the "pTrigger" member of the associated
1576 * struct Table.
danielk1977d99bc932002-05-16 00:13:12 +00001577 *
drhad3cab52002-05-24 02:04:32 +00001578 * The "step_list" member points to the first element of a linked list
1579 * containing the SQL statements specified as the trigger program.
danielk1977d99bc932002-05-16 00:13:12 +00001580 */
danielk1977c3f9bad2002-05-15 08:30:12 +00001581struct Trigger {
drhdc379452002-05-15 12:45:43 +00001582 char *name; /* The name of the trigger */
1583 char *table; /* The table or view to which the trigger applies */
drhf0f258b2003-04-21 18:48:45 +00001584 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */
drhdca76842004-12-07 14:06:13 +00001585 u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
drhdc379452002-05-15 12:45:43 +00001586 Expr *pWhen; /* The WHEN clause of the expresion (may be NULL) */
1587 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger,
danielk1977d99bc932002-05-16 00:13:12 +00001588 the <column-list> is stored here */
drh4312db52003-06-03 01:47:11 +00001589 Token nameToken; /* Token containing zName. Use during parsing only */
danielk1977e501b892006-01-09 06:29:47 +00001590 Schema *pSchema; /* Schema containing the trigger */
1591 Schema *pTabSchema; /* Schema containing the table */
drhdc379452002-05-15 12:45:43 +00001592 TriggerStep *step_list; /* Link list of trigger program steps */
drhdc379452002-05-15 12:45:43 +00001593 Trigger *pNext; /* Next trigger associated with the table */
danielk1977c3f9bad2002-05-15 08:30:12 +00001594};
1595
danielk1977d99bc932002-05-16 00:13:12 +00001596/*
drhdca76842004-12-07 14:06:13 +00001597** A trigger is either a BEFORE or an AFTER trigger. The following constants
1598** determine which.
1599**
1600** If there are multiple triggers, you might of some BEFORE and some AFTER.
1601** In that cases, the constants below can be ORed together.
1602*/
1603#define TRIGGER_BEFORE 1
1604#define TRIGGER_AFTER 2
1605
1606/*
danielk1977d99bc932002-05-16 00:13:12 +00001607 * An instance of struct TriggerStep is used to store a single SQL statement
1608 * that is a part of a trigger-program.
1609 *
1610 * Instances of struct TriggerStep are stored in a singly linked list (linked
1611 * using the "pNext" member) referenced by the "step_list" member of the
1612 * associated struct Trigger instance. The first element of the linked list is
1613 * the first step of the trigger-program.
1614 *
1615 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
1616 * "SELECT" statement. The meanings of the other members is determined by the
1617 * value of "op" as follows:
1618 *
1619 * (op == TK_INSERT)
1620 * orconf -> stores the ON CONFLICT algorithm
1621 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then
1622 * this stores a pointer to the SELECT statement. Otherwise NULL.
1623 * target -> A token holding the name of the table to insert into.
1624 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
1625 * this stores values to be inserted. Otherwise NULL.
1626 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ...
drhad3cab52002-05-24 02:04:32 +00001627 * statement, then this stores the column-names to be
1628 * inserted into.
danielk1977d99bc932002-05-16 00:13:12 +00001629 *
1630 * (op == TK_DELETE)
1631 * target -> A token holding the name of the table to delete from.
1632 * pWhere -> The WHERE clause of the DELETE statement if one is specified.
1633 * Otherwise NULL.
1634 *
1635 * (op == TK_UPDATE)
1636 * target -> A token holding the name of the table to update rows of.
1637 * pWhere -> The WHERE clause of the UPDATE statement if one is specified.
1638 * Otherwise NULL.
1639 * pExprList -> A list of the columns to update and the expressions to update
danielk19774adee202004-05-08 08:23:19 +00001640 * them to. See sqlite3Update() documentation of "pChanges"
drhad3cab52002-05-24 02:04:32 +00001641 * argument.
danielk1977d99bc932002-05-16 00:13:12 +00001642 *
1643 */
1644struct TriggerStep {
1645 int op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1646 int orconf; /* OE_Rollback etc. */
drha69d9162003-04-17 22:57:53 +00001647 Trigger *pTrig; /* The trigger that this step is a part of */
danielk1977c3f9bad2002-05-15 08:30:12 +00001648
danielk1977d99bc932002-05-16 00:13:12 +00001649 Select *pSelect; /* Valid for SELECT and sometimes
drhfd131da2007-08-07 17:13:03 +00001650 INSERT steps (when pExprList == 0) */
danielk1977d99bc932002-05-16 00:13:12 +00001651 Token target; /* Valid for DELETE, UPDATE, INSERT steps */
1652 Expr *pWhere; /* Valid for DELETE, UPDATE steps */
1653 ExprList *pExprList; /* Valid for UPDATE statements and sometimes
drhfd131da2007-08-07 17:13:03 +00001654 INSERT steps (when pSelect == 0) */
danielk1977d99bc932002-05-16 00:13:12 +00001655 IdList *pIdList; /* Valid for INSERT statements only */
drh187e4c62006-02-27 22:22:27 +00001656 TriggerStep *pNext; /* Next in the link-list */
1657 TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */
danielk1977d99bc932002-05-16 00:13:12 +00001658};
1659
1660/*
1661 * An instance of struct TriggerStack stores information required during code
1662 * generation of a single trigger program. While the trigger program is being
1663 * coded, its associated TriggerStack instance is pointed to by the
1664 * "pTriggerStack" member of the Parse structure.
1665 *
1666 * The pTab member points to the table that triggers are being coded on. The
1667 * newIdx member contains the index of the vdbe cursor that points at the temp
1668 * table that stores the new.* references. If new.* references are not valid
1669 * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1670 * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1671 *
1672 * The ON CONFLICT policy to be used for the trigger program steps is stored
1673 * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1674 * specified for individual triggers steps is used.
1675 *
1676 * struct TriggerStack has a "pNext" member, to allow linked lists to be
1677 * constructed. When coding nested triggers (triggers fired by other triggers)
1678 * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1679 * pointer. Once the nested trigger has been coded, the pNext value is restored
1680 * to the pTriggerStack member of the Parse stucture and coding of the parent
1681 * trigger continues.
1682 *
1683 * Before a nested trigger is coded, the linked list pointed to by the
1684 * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1685 * recursively. If this condition is detected, the nested trigger is not coded.
1686 */
1687struct TriggerStack {
1688 Table *pTab; /* Table that triggers are currently being coded on */
1689 int newIdx; /* Index of vdbe cursor to "new" temp table */
1690 int oldIdx; /* Index of vdbe cursor to "old" temp table */
danielk19778f2c54e2008-01-01 19:02:09 +00001691 u32 newColMask;
1692 u32 oldColMask;
danielk1977d99bc932002-05-16 00:13:12 +00001693 int orconf; /* Current orconf policy */
danielk19776f349032002-06-11 02:25:40 +00001694 int ignoreJump; /* where to jump to for a RAISE(IGNORE) */
drhe22a3342003-04-22 20:30:37 +00001695 Trigger *pTrigger; /* The trigger currently being coded */
1696 TriggerStack *pNext; /* Next trigger down on the trigger stack */
danielk1977d99bc932002-05-16 00:13:12 +00001697};
1698
1699/*
drhf26e09c2003-05-31 16:21:12 +00001700** The following structure contains information used by the sqliteFix...
1701** routines as they walk the parse tree to make database references
1702** explicit.
1703*/
1704typedef struct DbFixer DbFixer;
1705struct DbFixer {
1706 Parse *pParse; /* The parsing context. Error messages written here */
1707 const char *zDb; /* Make sure all objects are contained in this database */
1708 const char *zType; /* Type of the container - used for error messages */
1709 const Token *pName; /* Name of the container - used for error messages */
1710};
1711
1712/*
drhade86482007-11-28 22:36:40 +00001713** An objected used to accumulate the text of a string where we
1714** do not necessarily know how big the string will be in the end.
1715*/
1716struct StrAccum {
1717 char *zBase; /* A base allocation. Not from malloc. */
1718 char *zText; /* The string collected so far */
1719 int nChar; /* Length of the string so far */
1720 int nAlloc; /* Amount of space allocated in zText */
drhbb4957f2008-03-20 14:03:29 +00001721 int mxAlloc; /* Maximum allowed string length */
drhade86482007-11-28 22:36:40 +00001722 u8 mallocFailed; /* Becomes true if any memory allocation fails */
1723 u8 useMalloc; /* True if zText is enlargable using realloc */
1724 u8 tooBig; /* Becomes true if string size exceeds limits */
1725};
1726
1727/*
drh234c39d2004-07-24 03:30:47 +00001728** A pointer to this structure is used to communicate information
1729** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
1730*/
1731typedef struct {
drh9bb575f2004-09-06 17:24:11 +00001732 sqlite3 *db; /* The database being initialized */
drhece3c722006-09-23 20:36:01 +00001733 int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */
drh234c39d2004-07-24 03:30:47 +00001734 char **pzErrMsg; /* Error message stored here */
drh15ca1df2006-07-26 13:43:30 +00001735 int rc; /* Result code stored here */
drh234c39d2004-07-24 03:30:47 +00001736} InitData;
1737
drhb6c29892004-11-22 19:12:19 +00001738/*
drh66150952007-07-23 19:12:41 +00001739** Assuming zIn points to the first byte of a UTF-8 character,
1740** advance zIn to point to the first byte of the next UTF-8 character.
drh4a919112007-05-15 11:55:09 +00001741*/
drh4a919112007-05-15 11:55:09 +00001742#define SQLITE_SKIP_UTF8(zIn) { \
1743 if( (*(zIn++))>=0xc0 ){ \
1744 while( (*zIn & 0xc0)==0x80 ){ zIn++; } \
1745 } \
1746}
1747
drh4a919112007-05-15 11:55:09 +00001748/*
drh49285702005-09-17 15:20:26 +00001749** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production
1750** builds) or a function call (for debugging). If it is a function call,
1751** it allows the operator to set a breakpoint at the spot where database
1752** corruption is first detected.
1753*/
1754#ifdef SQLITE_DEBUG
drh6e736832007-05-11 12:30:03 +00001755 int sqlite3Corrupt(void);
drh49285702005-09-17 15:20:26 +00001756# define SQLITE_CORRUPT_BKPT sqlite3Corrupt()
drhe5fe6902007-12-07 18:55:28 +00001757# define DEBUGONLY(X) X
drh49285702005-09-17 15:20:26 +00001758#else
1759# define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT
drhe5fe6902007-12-07 18:55:28 +00001760# define DEBUGONLY(X)
drh49285702005-09-17 15:20:26 +00001761#endif
1762
1763/*
drh75897232000-05-29 14:26:00 +00001764** Internal function prototypes
1765*/
danielk19774adee202004-05-08 08:23:19 +00001766int sqlite3StrICmp(const char *, const char *);
1767int sqlite3StrNICmp(const char *, const char *, int);
danielk19778a6b5412004-05-24 07:04:25 +00001768int sqlite3IsNumber(const char*, int*, u8);
danielk19772e588c72005-12-09 14:25:08 +00001769
drh17435752007-08-16 04:30:38 +00001770void *sqlite3MallocZero(unsigned);
1771void *sqlite3DbMallocZero(sqlite3*, unsigned);
1772void *sqlite3DbMallocRaw(sqlite3*, unsigned);
danielk19772e588c72005-12-09 14:25:08 +00001773char *sqlite3StrDup(const char*);
1774char *sqlite3StrNDup(const char*, int);
drh17435752007-08-16 04:30:38 +00001775char *sqlite3DbStrDup(sqlite3*,const char*);
1776char *sqlite3DbStrNDup(sqlite3*,const char*, int);
drh97c8ec32007-08-27 21:49:34 +00001777void *sqlite3DbReallocOrFree(sqlite3 *, void *, int);
danielk1977a1644fd2007-08-29 12:31:25 +00001778void *sqlite3DbRealloc(sqlite3 *, void *, int);
danielk1977a7a8e142008-02-13 18:25:27 +00001779int sqlite3MallocSize(void *);
danielk19772e588c72005-12-09 14:25:08 +00001780
drh17435752007-08-16 04:30:38 +00001781char *sqlite3MPrintf(sqlite3*,const char*, ...);
1782char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
drh87cc3b32007-05-08 21:45:27 +00001783#if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
1784 void sqlite3DebugPrintf(const char*, ...);
drhd919fe12007-12-11 19:34:44 +00001785#endif
1786#if defined(SQLITE_TEST)
drh87cc3b32007-05-08 21:45:27 +00001787 void *sqlite3TextToPtr(const char*);
1788#endif
drh41f58522005-06-06 15:06:39 +00001789void sqlite3SetString(char **, ...);
danielk19774adee202004-05-08 08:23:19 +00001790void sqlite3ErrorMsg(Parse*, const char*, ...);
drha0733842005-12-29 01:11:36 +00001791void sqlite3ErrorClear(Parse*);
danielk19774adee202004-05-08 08:23:19 +00001792void sqlite3Dequote(char*);
drh17435752007-08-16 04:30:38 +00001793void sqlite3DequoteExpr(sqlite3*, Expr*);
drh2646da72005-12-09 20:02:05 +00001794int sqlite3KeywordCode(const unsigned char*, int);
danielk19774adee202004-05-08 08:23:19 +00001795int sqlite3RunParser(Parse*, const char*, char **);
drh80242052004-06-09 00:48:12 +00001796void sqlite3FinishCoding(Parse*);
drh892d3172008-01-10 03:46:36 +00001797int sqlite3GetTempReg(Parse*);
1798void sqlite3ReleaseTempReg(Parse*,int);
1799int sqlite3GetTempRange(Parse*,int);
1800void sqlite3ReleaseTempRange(Parse*,int,int);
danielk1977a1644fd2007-08-29 12:31:25 +00001801Expr *sqlite3Expr(sqlite3*, int, Expr*, Expr*, const Token*);
drh17435752007-08-16 04:30:38 +00001802Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*);
drh4e0cff62004-11-05 05:10:28 +00001803Expr *sqlite3RegisterExpr(Parse*,Token*);
danielk19771e536952007-08-16 10:09:01 +00001804Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
danielk19774adee202004-05-08 08:23:19 +00001805void sqlite3ExprSpan(Expr*,Token*,Token*);
drh17435752007-08-16 04:30:38 +00001806Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
drhfa6bc002004-09-07 16:19:52 +00001807void sqlite3ExprAssignVarNumber(Parse*, Expr*);
danielk19774adee202004-05-08 08:23:19 +00001808void sqlite3ExprDelete(Expr*);
drh17435752007-08-16 04:30:38 +00001809ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*,Token*);
danielk19774adee202004-05-08 08:23:19 +00001810void sqlite3ExprListDelete(ExprList*);
drh9bb575f2004-09-06 17:24:11 +00001811int sqlite3Init(sqlite3*, char**);
drh234c39d2004-07-24 03:30:47 +00001812int sqlite3InitCallback(void*, int, char**, char**);
danielk197791cf71b2004-06-26 06:37:06 +00001813void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
drh9bb575f2004-09-06 17:24:11 +00001814void sqlite3ResetInternalSchema(sqlite3*, int);
danielk19774adee202004-05-08 08:23:19 +00001815void sqlite3BeginParse(Parse*,int);
drh9bb575f2004-09-06 17:24:11 +00001816void sqlite3CommitInternalChanges(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00001817Table *sqlite3ResultSetOfSelect(Parse*,char*,Select*);
danielk1977c00da102006-01-07 13:21:04 +00001818void sqlite3OpenMasterTable(Parse *, int);
danielk1977f1a381e2006-06-16 08:01:02 +00001819void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
danielk19774adee202004-05-08 08:23:19 +00001820void sqlite3AddColumn(Parse*,Token*);
1821void sqlite3AddNotNull(Parse*, int);
drhfdd6e852005-12-16 01:06:16 +00001822void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
drhffe07b22005-11-03 00:41:17 +00001823void sqlite3AddCheckConstraint(Parse*, Expr*);
drh487e2622005-06-25 18:42:14 +00001824void sqlite3AddColumnType(Parse*,Token*);
danielk19777977a172004-11-09 12:44:37 +00001825void sqlite3AddDefaultValue(Parse*,Expr*);
danielk197739002502007-11-12 09:50:26 +00001826void sqlite3AddCollateType(Parse*, Token*);
danielk197719a8e7e2005-03-17 05:03:38 +00001827void sqlite3EndTable(Parse*,Token*,Token*,Select*);
drhb7f91642004-10-31 02:22:47 +00001828
drhf5e7bb52008-02-18 14:47:33 +00001829Bitvec *sqlite3BitvecCreate(u32);
1830int sqlite3BitvecTest(Bitvec*, u32);
1831int sqlite3BitvecSet(Bitvec*, u32);
1832void sqlite3BitvecClear(Bitvec*, u32);
1833void sqlite3BitvecDestroy(Bitvec*);
drh3088d592008-03-21 16:45:47 +00001834int sqlite3BitvecBuiltinTest(int,int*);
drhf5e7bb52008-02-18 14:47:33 +00001835
drhfdd48a72006-09-11 23:45:48 +00001836void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int);
danielk1977fe3fcbe22006-06-12 12:08:45 +00001837
1838#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
drhb7f91642004-10-31 02:22:47 +00001839 int sqlite3ViewGetColumnNames(Parse*,Table*);
1840#else
1841# define sqlite3ViewGetColumnNames(A,B) 0
1842#endif
1843
drha0733842005-12-29 01:11:36 +00001844void sqlite3DropTable(Parse*, SrcList*, int, int);
danielk1977a04a34f2007-04-16 15:06:25 +00001845void sqlite3DeleteTable(Table*);
danielk19774adee202004-05-08 08:23:19 +00001846void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
drh17435752007-08-16 04:30:38 +00001847void *sqlite3ArrayAllocate(sqlite3*,void*,int,int,int*,int*,int*);
1848IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
danielk19774adee202004-05-08 08:23:19 +00001849int sqlite3IdListIndex(IdList*,const char*);
drh17435752007-08-16 04:30:38 +00001850SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
1851SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*, Token*,
drh61dfc312006-12-16 16:25:15 +00001852 Select*, Expr*, IdList*);
1853void sqlite3SrcListShiftJoinType(SrcList*);
danielk19774adee202004-05-08 08:23:19 +00001854void sqlite3SrcListAssignCursors(Parse*, SrcList*);
1855void sqlite3IdListDelete(IdList*);
1856void sqlite3SrcListDelete(SrcList*);
danielk19770202b292004-06-09 09:55:16 +00001857void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
drh4d91a702006-01-04 15:54:36 +00001858 Token*, int, int);
1859void sqlite3DropIndex(Parse*, SrcList*, int);
danielk19776c8c8ce2008-01-02 16:27:09 +00001860int sqlite3Select(Parse*, Select*, SelectDest*, Select*, int, int*, char *aff);
drh17435752007-08-16 04:30:38 +00001861Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
1862 Expr*,ExprList*,int,Expr*,Expr*);
danielk19774adee202004-05-08 08:23:19 +00001863void sqlite3SelectDelete(Select*);
danielk19774adee202004-05-08 08:23:19 +00001864Table *sqlite3SrcListLookup(Parse*, SrcList*);
1865int sqlite3IsReadOnly(Parse*, Table*, int);
danielk1977c00da102006-01-07 13:21:04 +00001866void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
danielk19774adee202004-05-08 08:23:19 +00001867void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
1868void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
danielk1977a9d1ccb2008-01-05 17:39:29 +00001869WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**, u8);
danielk19774adee202004-05-08 08:23:19 +00001870void sqlite3WhereEnd(WhereInfo*);
drhda250ea2008-04-01 05:07:14 +00001871int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, int);
drhe55cbd72008-03-31 23:48:03 +00001872void sqlite3ExprCodeMove(Parse*, int, int);
1873void sqlite3ExprClearColumnCache(Parse*, int);
drhda250ea2008-04-01 05:07:14 +00001874void sqlite3ExprCacheAffinityChange(Parse*, int, int);
drh652fbf52008-04-01 01:42:41 +00001875int sqlite3ExprWritableRegister(Parse*,int,int);
drh191b54c2008-04-15 12:14:21 +00001876void sqlite3ExprHardCopy(Parse*,int,int);
drh389a1ad2008-01-03 23:44:53 +00001877int sqlite3ExprCode(Parse*, Expr*, int);
drh2dcef112008-01-12 19:03:48 +00001878int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
drh678ccce2008-03-31 18:19:54 +00001879int sqlite3ExprCodeTarget(Parse*, Expr*, int);
drh2dcef112008-01-12 19:03:48 +00001880int sqlite3ExprCodeAndCache(Parse*, Expr*, int);
drh678ccce2008-03-31 18:19:54 +00001881void sqlite3ExprCodeConstants(Parse*, Expr*);
drh191b54c2008-04-15 12:14:21 +00001882int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int);
danielk19774adee202004-05-08 08:23:19 +00001883void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
1884void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
drh9bb575f2004-09-06 17:24:11 +00001885Table *sqlite3FindTable(sqlite3*,const char*, const char*);
drhca424112008-01-25 15:04:48 +00001886Table *sqlite3LocateTable(Parse*,int isView,const char*, const char*);
drh9bb575f2004-09-06 17:24:11 +00001887Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
1888void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
1889void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
drh74161702006-02-24 02:53:49 +00001890void sqlite3Vacuum(Parse*);
drh9bb575f2004-09-06 17:24:11 +00001891int sqlite3RunVacuum(char**, sqlite3*);
drh17435752007-08-16 04:30:38 +00001892char *sqlite3NameFromToken(sqlite3*, Token*);
danielk19774adee202004-05-08 08:23:19 +00001893int sqlite3ExprCompare(Expr*, Expr*);
danielk1977b3bce662005-01-29 08:32:43 +00001894int sqlite3ExprResolveNames(NameContext *, Expr *);
drhd2b3e232008-01-23 14:51:49 +00001895void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
1896void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
danielk19774adee202004-05-08 08:23:19 +00001897Vdbe *sqlite3GetVdbe(Parse*);
danielk19771e536952007-08-16 10:09:01 +00001898Expr *sqlite3CreateIdExpr(Parse *, const char*);
drh2fa18682008-03-19 14:15:34 +00001899void sqlite3PrngSaveState(void);
1900void sqlite3PrngRestoreState(void);
1901void sqlite3PrngResetState(void);
drh9bb575f2004-09-06 17:24:11 +00001902void sqlite3RollbackAll(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00001903void sqlite3CodeVerifySchema(Parse*, int);
drh684917c2004-10-05 02:41:42 +00001904void sqlite3BeginTransaction(Parse*, int);
danielk19774adee202004-05-08 08:23:19 +00001905void sqlite3CommitTransaction(Parse*);
1906void sqlite3RollbackTransaction(Parse*);
1907int sqlite3ExprIsConstant(Expr*);
drh0a168372007-06-08 00:20:47 +00001908int sqlite3ExprIsConstantNotJoin(Expr*);
drheb55bd22005-06-30 17:04:21 +00001909int sqlite3ExprIsConstantOrFunction(Expr*);
danielk19774adee202004-05-08 08:23:19 +00001910int sqlite3ExprIsInteger(Expr*, int*);
1911int sqlite3IsRowid(const char*);
drh2d401ab2008-01-10 23:50:11 +00001912void sqlite3GenerateRowDelete(Parse*, Table*, int, int, int);
1913void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int*);
drhe14006d2008-03-25 17:23:32 +00001914int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int);
drh04adf412008-01-08 18:57:50 +00001915void sqlite3GenerateConstraintChecks(Parse*,Table*,int,int,
1916 int*,int,int,int,int);
1917void sqlite3CompleteInsertion(Parse*, Table*, int, int, int*,int,int,int,int);
drhaa9b8962008-01-08 02:57:55 +00001918int sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
danielk19774adee202004-05-08 08:23:19 +00001919void sqlite3BeginWriteOperation(Parse*, int, int);
drh17435752007-08-16 04:30:38 +00001920Expr *sqlite3ExprDup(sqlite3*,Expr*);
1921void sqlite3TokenCopy(sqlite3*,Token*, Token*);
1922ExprList *sqlite3ExprListDup(sqlite3*,ExprList*);
1923SrcList *sqlite3SrcListDup(sqlite3*,SrcList*);
1924IdList *sqlite3IdListDup(sqlite3*,IdList*);
1925Select *sqlite3SelectDup(sqlite3*,Select*);
drh9bb575f2004-09-06 17:24:11 +00001926FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
1927void sqlite3RegisterBuiltinFunctions(sqlite3*);
1928void sqlite3RegisterDateTimeFunctions(sqlite3*);
drh7e8b8482008-01-23 03:03:05 +00001929#ifdef SQLITE_DEBUG
1930 int sqlite3SafetyOn(sqlite3*);
1931 int sqlite3SafetyOff(sqlite3*);
1932#else
1933# define sqlite3SafetyOn(A) 0
1934# define sqlite3SafetyOff(A) 0
1935#endif
1936int sqlite3SafetyCheckOk(sqlite3*);
1937int sqlite3SafetyCheckSickOrOk(sqlite3*);
drh9cbf3422008-01-17 16:22:13 +00001938void sqlite3ChangeCookie(Parse*, int);
drhf93d9992008-04-15 14:36:42 +00001939void sqlite3MaterializeView(Parse*, Select*, Expr*, int);
drhb7f91642004-10-31 02:22:47 +00001940
1941#ifndef SQLITE_OMIT_TRIGGER
1942 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
drh60218d22007-04-06 11:26:00 +00001943 Expr*,int, int);
drhb7f91642004-10-31 02:22:47 +00001944 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
drhfdd48a72006-09-11 23:45:48 +00001945 void sqlite3DropTrigger(Parse*, SrcList*, int);
drh74161702006-02-24 02:53:49 +00001946 void sqlite3DropTriggerPtr(Parse*, Trigger*);
drhdca76842004-12-07 14:06:13 +00001947 int sqlite3TriggersExist(Parse*, Table*, int, ExprList*);
drhb7f91642004-10-31 02:22:47 +00001948 int sqlite3CodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
danielk19778f2c54e2008-01-01 19:02:09 +00001949 int, int, u32*, u32*);
drhb7f91642004-10-31 02:22:47 +00001950 void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
1951 void sqlite3DeleteTriggerStep(TriggerStep*);
drh17435752007-08-16 04:30:38 +00001952 TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*);
1953 TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
1954 ExprList*,Select*,int);
1955 TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, int);
1956 TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*);
drhb7f91642004-10-31 02:22:47 +00001957 void sqlite3DeleteTrigger(Trigger*);
1958 void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
1959#else
1960# define sqlite3TriggersExist(A,B,C,D,E,F) 0
1961# define sqlite3DeleteTrigger(A)
drhcdd536f2006-03-17 00:04:03 +00001962# define sqlite3DropTriggerPtr(A,B)
drhb7f91642004-10-31 02:22:47 +00001963# define sqlite3UnlinkAndDeleteTrigger(A,B,C)
danielk19778f2c54e2008-01-01 19:02:09 +00001964# define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I,J,K) 0
drhb7f91642004-10-31 02:22:47 +00001965#endif
1966
danielk19774adee202004-05-08 08:23:19 +00001967int sqlite3JoinType(Parse*, Token*, Token*, Token*);
danielk19770202b292004-06-09 09:55:16 +00001968void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
danielk19774adee202004-05-08 08:23:19 +00001969void sqlite3DeferForeignKey(Parse*, int);
drhed6c8672003-01-12 18:02:16 +00001970#ifndef SQLITE_OMIT_AUTHORIZATION
drh728b5772007-09-18 15:55:07 +00001971 void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
danielk19774adee202004-05-08 08:23:19 +00001972 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
1973 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
1974 void sqlite3AuthContextPop(AuthContext*);
drhed6c8672003-01-12 18:02:16 +00001975#else
danielk1977b5258c32007-10-04 18:11:15 +00001976# define sqlite3AuthRead(a,b,c,d)
danielk19774adee202004-05-08 08:23:19 +00001977# define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK
1978# define sqlite3AuthContextPush(a,b,c)
1979# define sqlite3AuthContextPop(a) ((void)(a))
drhed6c8672003-01-12 18:02:16 +00001980#endif
danielk1977f744bb52005-12-06 17:19:11 +00001981void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
1982void sqlite3Detach(Parse*, Expr*);
drh9bb575f2004-09-06 17:24:11 +00001983int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
drh33f4e022007-09-03 15:19:34 +00001984 int omitJournal, int nCache, int flags, Btree **ppBtree);
danielk19774adee202004-05-08 08:23:19 +00001985int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
1986int sqlite3FixSrcList(DbFixer*, SrcList*);
1987int sqlite3FixSelect(DbFixer*, Select*);
1988int sqlite3FixExpr(DbFixer*, Expr*);
1989int sqlite3FixExprList(DbFixer*, ExprList*);
1990int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
drh487e2622005-06-25 18:42:14 +00001991int sqlite3AtoF(const char *z, double*);
danielk19776f8a5032004-05-10 10:34:51 +00001992char *sqlite3_snprintf(int,char*,const char*,...);
drhfec19aa2004-05-19 20:41:03 +00001993int sqlite3GetInt32(const char *, int*);
drh598f1342007-10-23 15:39:45 +00001994int sqlite3FitsIn64Bits(const char *, int);
drhee858132007-05-08 20:37:38 +00001995int sqlite3Utf16ByteLen(const void *pData, int nChar);
1996int sqlite3Utf8CharLen(const char *pData, int nByte);
drh66150952007-07-23 19:12:41 +00001997int sqlite3Utf8Read(const u8*, const u8*, const u8**);
drh35b5a332008-04-05 18:41:42 +00001998int sqlite3PutVarint(unsigned char*, u64);
1999int sqlite3PutVarint32(unsigned char*, u32);
danielk197790e4d952004-05-10 10:05:53 +00002000int sqlite3GetVarint(const unsigned char *, u64 *);
drh6d2fb152004-05-14 16:50:06 +00002001int sqlite3GetVarint32(const unsigned char *, u32 *);
danielk1977192ac1d2004-05-10 07:17:30 +00002002int sqlite3VarintLen(u64 v);
danielk1977a37cdde2004-05-16 11:15:36 +00002003void sqlite3IndexAffinityStr(Vdbe *, Index *);
2004void sqlite3TableAffinityStr(Vdbe *, Table *);
danielk1977e014a832004-05-17 10:48:57 +00002005char sqlite3CompareAffinity(Expr *pExpr, char aff2);
danielk1977e014a832004-05-17 10:48:57 +00002006int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
danielk1977bf3b7212004-05-18 10:06:24 +00002007char sqlite3ExprAffinity(Expr *pExpr);
drhb6a9ece2007-06-26 00:37:27 +00002008int sqlite3Atoi64(const char*, i64*);
drh9bb575f2004-09-06 17:24:11 +00002009void sqlite3Error(sqlite3*, int, const char*,...);
drhca48c902008-01-18 14:08:24 +00002010void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
danielk1977ef2cb632004-05-29 02:37:19 +00002011int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
danielk1977f20b21c2004-05-31 23:56:42 +00002012const char *sqlite3ErrStr(int);
danielk19778a414492004-06-29 08:59:35 +00002013int sqlite3ReadSchema(Parse *pParse);
drh9bb575f2004-09-06 17:24:11 +00002014CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
danielk19770202b292004-06-09 09:55:16 +00002015CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
danielk19777cedc8d2004-06-10 10:50:08 +00002016CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
drh8b4c40d2007-02-01 23:02:45 +00002017Expr *sqlite3ExprSetColl(Parse *pParse, Expr *, Token *);
danielk19777cedc8d2004-06-10 10:50:08 +00002018int sqlite3CheckCollSeq(Parse *, CollSeq *);
danielk1977d8123362004-06-12 09:25:12 +00002019int sqlite3CheckObjectName(Parse *, const char *);
danielk1977b28af712004-06-21 06:50:26 +00002020void sqlite3VdbeSetChanges(sqlite3 *, int);
danielk19774e6af132004-06-10 14:01:08 +00002021
drhb21c8cd2007-08-21 19:33:56 +00002022const void *sqlite3ValueText(sqlite3_value*, u8);
2023int sqlite3ValueBytes(sqlite3_value*, u8);
2024void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
danielk19771e536952007-08-16 10:09:01 +00002025 void(*)(void*));
danielk19774e6af132004-06-10 14:01:08 +00002026void sqlite3ValueFree(sqlite3_value*);
danielk19771e536952007-08-16 10:09:01 +00002027sqlite3_value *sqlite3ValueNew(sqlite3 *);
2028char *sqlite3Utf16to8(sqlite3 *, const void*, int);
2029int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
drhb21c8cd2007-08-21 19:33:56 +00002030void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
drh46c99e02007-08-27 23:26:59 +00002031#ifndef SQLITE_AMALGAMATION
drh4e5ffc52004-08-31 00:52:37 +00002032extern const unsigned char sqlite3UpperToLower[];
drh46c99e02007-08-27 23:26:59 +00002033#endif
danielk1977a0bf2652004-11-04 14:30:04 +00002034void sqlite3RootPageMoved(Db*, int, int);
drh4343fea2004-11-05 23:46:15 +00002035void sqlite3Reindex(Parse*, Token*, Token*);
drh1f01ec12005-02-15 21:36:18 +00002036void sqlite3AlterFunctions(sqlite3*);
danielk19779fd2a9a2004-11-12 13:42:30 +00002037void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
2038int sqlite3GetToken(const unsigned char *, int *);
drh2958a4e2004-11-12 03:56:15 +00002039void sqlite3NestedParse(Parse*, const char*, ...);
drhd89bd002005-01-22 03:03:54 +00002040void sqlite3ExpirePreparedStatements(sqlite3*);
danielk1977b3bce662005-01-29 08:32:43 +00002041void sqlite3CodeSubselect(Parse *, Expr *);
2042int sqlite3SelectResolve(Parse *, Select *, NameContext *);
danielk1977aee18ef2005-03-09 12:26:50 +00002043void sqlite3ColumnDefault(Vdbe *, Table *, int);
danielk197719a8e7e2005-03-17 05:03:38 +00002044void sqlite3AlterFinishAddColumn(Parse *, Token *);
2045void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
danielk19774dade032005-05-25 10:45:10 +00002046CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int);
drh8a512562005-11-14 22:29:05 +00002047char sqlite3AffinityType(const Token*);
drh9f18e8a2005-07-08 12:13:04 +00002048void sqlite3Analyze(Parse*, Token*, Token*);
drha4afb652005-07-09 02:16:02 +00002049int sqlite3InvokeBusyHandler(BusyHandler*);
drhff2d5ea2005-07-23 00:41:48 +00002050int sqlite3FindDb(sqlite3*, Token*);
drhcf1be452007-05-12 12:08:51 +00002051int sqlite3AnalysisLoad(sqlite3*,int iDB);
drh51147ba2005-07-23 22:59:55 +00002052void sqlite3DefaultRowEst(Index*);
drh55ef4d92005-08-14 01:20:37 +00002053void sqlite3RegisterLikeFunctions(sqlite3*, int);
drhd64fe2f2005-08-28 17:00:23 +00002054int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
danielk1977f744bb52005-12-06 17:19:11 +00002055void sqlite3AttachFunctions(sqlite3 *);
drhfdd6e852005-12-16 01:06:16 +00002056void sqlite3MinimumFileFormat(Parse*, int, int);
danielk1977da184232006-01-05 11:34:32 +00002057void sqlite3SchemaFree(void *);
danielk19771e536952007-08-16 10:09:01 +00002058Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
danielk1977e501b892006-01-09 06:29:47 +00002059int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
danielk1977b3bf5562006-01-10 17:58:23 +00002060KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *);
danielk1977771151b2006-01-17 13:21:40 +00002061int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
2062 void (*)(sqlite3_context*,int,sqlite3_value **),
2063 void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*));
danielk197754f01982006-01-18 15:25:17 +00002064int sqlite3ApiExit(sqlite3 *db, int);
danielk1977ddfb2f02006-02-17 12:25:14 +00002065int sqlite3OpenTempDatabase(Parse *);
drh69dab1d2006-06-27 14:37:20 +00002066
drhade86482007-11-28 22:36:40 +00002067void sqlite3StrAccumAppend(StrAccum*,const char*,int);
2068char *sqlite3StrAccumFinish(StrAccum*);
2069void sqlite3StrAccumReset(StrAccum*);
drh1013c932008-01-06 00:25:21 +00002070void sqlite3SelectDestInit(SelectDest*,int,int);
danielk19771e536952007-08-16 10:09:01 +00002071
drh95bdbbb2007-07-23 19:31:16 +00002072/*
2073** The interface to the LEMON-generated parser
2074*/
2075void *sqlite3ParserAlloc(void*(*)(size_t));
2076void sqlite3ParserFree(void*, void(*)(void*));
2077void sqlite3Parser(void*, int, Token, Parse*);
2078
drhcaa639f2008-03-20 00:32:20 +00002079int sqlite3AutoLoadExtensions(sqlite3*);
drh69dab1d2006-06-27 14:37:20 +00002080#ifndef SQLITE_OMIT_LOAD_EXTENSION
2081 void sqlite3CloseExtensions(sqlite3*);
2082#else
2083# define sqlite3CloseExtensions(X)
2084#endif
danielk1977e3026632004-06-22 11:29:02 +00002085
danielk1977c00da102006-01-07 13:21:04 +00002086#ifndef SQLITE_OMIT_SHARED_CACHE
2087 void sqlite3TableLock(Parse *, int, int, u8, const char *);
2088#else
2089 #define sqlite3TableLock(v,w,x,y,z)
2090#endif
2091
drh53c14022007-05-10 17:23:11 +00002092#ifdef SQLITE_TEST
2093 int sqlite3Utf8To8(unsigned char*);
2094#endif
2095
drhb9bb7c12006-06-11 23:41:55 +00002096#ifdef SQLITE_OMIT_VIRTUALTABLE
2097# define sqlite3VtabClear(X)
danielk1977f9e7dda2006-06-16 16:08:53 +00002098# define sqlite3VtabSync(X,Y) (Y)
2099# define sqlite3VtabRollback(X)
2100# define sqlite3VtabCommit(X)
drhb9bb7c12006-06-11 23:41:55 +00002101#else
drh707205d2006-06-17 10:44:42 +00002102 void sqlite3VtabClear(Table*);
danielk1977f9e7dda2006-06-16 16:08:53 +00002103 int sqlite3VtabSync(sqlite3 *db, int rc);
2104 int sqlite3VtabRollback(sqlite3 *db);
2105 int sqlite3VtabCommit(sqlite3 *db);
drhb9bb7c12006-06-11 23:41:55 +00002106#endif
drh189d4af2006-09-02 20:57:52 +00002107void sqlite3VtabLock(sqlite3_vtab*);
danielk1977a04a34f2007-04-16 15:06:25 +00002108void sqlite3VtabUnlock(sqlite3*, sqlite3_vtab*);
drhb9bb7c12006-06-11 23:41:55 +00002109void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*);
2110void sqlite3VtabFinishParse(Parse*, Token*);
2111void sqlite3VtabArgInit(Parse*);
2112void sqlite3VtabArgExtend(Parse*, Token*);
danielk197778efaba2006-06-12 06:09:17 +00002113int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
danielk19777e6ebfb2006-06-12 11:24:37 +00002114int sqlite3VtabCallConnect(Parse*, Table*);
danielk19779e39ce82006-06-12 16:01:21 +00002115int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
danielk1977f9e7dda2006-06-16 16:08:53 +00002116int sqlite3VtabBegin(sqlite3 *, sqlite3_vtab *);
danielk19771e536952007-08-16 10:09:01 +00002117FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
drhb7481e72006-09-16 21:45:14 +00002118void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
drhb900aaf2006-11-09 00:24:53 +00002119int sqlite3Reprepare(Vdbe*);
drhb1a6c3c2008-03-20 16:30:17 +00002120void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*);
drh0a0e1312007-08-07 17:04:59 +00002121CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
drhb9bb7c12006-06-11 23:41:55 +00002122
drh643167f2008-01-22 21:30:53 +00002123
2124/*
2125** Available fault injectors. Should be numbered beginning with 0.
2126*/
2127#define SQLITE_FAULTINJECTOR_MALLOC 0
drh7e8b8482008-01-23 03:03:05 +00002128#define SQLITE_FAULTINJECTOR_COUNT 1
drh643167f2008-01-22 21:30:53 +00002129
2130/*
2131** The interface to the fault injector subsystem. If the fault injector
2132** mechanism is disabled at compile-time then set up macros so that no
2133** unnecessary code is generated.
2134*/
drh3088d592008-03-21 16:45:47 +00002135#ifndef SQLITE_OMIT_BUILTIN_TEST
drh643167f2008-01-22 21:30:53 +00002136 void sqlite3FaultConfig(int,int,int);
2137 int sqlite3FaultFailures(int);
2138 int sqlite3FaultBenignFailures(int);
2139 int sqlite3FaultPending(int);
2140 void sqlite3FaultBenign(int,int);
2141 int sqlite3FaultStep(int);
2142#else
2143# define sqlite3FaultConfig(A,B,C)
2144# define sqlite3FaultFailures(A) 0
2145# define sqlite3FaultBenignFailures(A) 0
2146# define sqlite3FaultPending(A) (-1)
2147# define sqlite3FaultBenign(A,B)
2148# define sqlite3FaultStep(A) 0
2149#endif
2150
2151
2152
danielk19779a96b662007-11-29 17:05:18 +00002153#define IN_INDEX_ROWID 1
2154#define IN_INDEX_EPH 2
2155#define IN_INDEX_INDEX 3
2156int sqlite3FindInIndex(Parse *, Expr *, int);
2157
danielk1977c7b60172007-08-22 11:22:03 +00002158#ifdef SQLITE_ENABLE_ATOMIC_WRITE
2159 int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
2160 int sqlite3JournalSize(sqlite3_vfs *);
danielk1977f55b8992007-08-24 08:15:53 +00002161 int sqlite3JournalCreate(sqlite3_file *);
danielk1977c7b60172007-08-22 11:22:03 +00002162#else
2163 #define sqlite3JournalSize(pVfs) ((pVfs)->szOsFile)
2164#endif
2165
danielk1977e6a58a42007-08-31 17:42:48 +00002166#if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
danielk1977fc976062007-05-10 10:46:56 +00002167 void sqlite3ExprSetHeight(Expr *);
2168 int sqlite3SelectExprHeight(Select *);
2169#else
2170 #define sqlite3ExprSetHeight(x)
2171#endif
2172
drha3152892007-05-05 11:48:52 +00002173u32 sqlite3Get4byte(const u8*);
drha3152892007-05-05 11:48:52 +00002174void sqlite3Put4byte(u8*, u32);
2175
danielk1977fd9a0a42005-05-24 12:01:00 +00002176#ifdef SQLITE_SSE
2177#include "sseInt.h"
2178#endif
2179
drh6e736832007-05-11 12:30:03 +00002180#ifdef SQLITE_DEBUG
2181 void sqlite3ParserTrace(FILE*, char *);
2182#endif
2183
drhb0603412007-02-28 04:47:26 +00002184/*
2185** If the SQLITE_ENABLE IOTRACE exists then the global variable
mlcreech3a00f902008-03-04 17:45:01 +00002186** sqlite3IoTrace is a pointer to a printf-like routine used to
drhb0603412007-02-28 04:47:26 +00002187** print I/O tracing messages.
2188*/
2189#ifdef SQLITE_ENABLE_IOTRACE
mlcreech3a00f902008-03-04 17:45:01 +00002190# define IOTRACE(A) if( sqlite3IoTrace ){ sqlite3IoTrace A; }
danielk1977b4622b62007-03-02 06:24:19 +00002191 void sqlite3VdbeIOTraceSql(Vdbe*);
drhb0603412007-02-28 04:47:26 +00002192#else
2193# define IOTRACE(A)
danielk1977b4622b62007-03-02 06:24:19 +00002194# define sqlite3VdbeIOTraceSql(X)
drhb0603412007-02-28 04:47:26 +00002195#endif
mlcreech3a00f902008-03-04 17:45:01 +00002196SQLITE_EXTERN void (*sqlite3IoTrace)(const char*,...);
drhb0603412007-02-28 04:47:26 +00002197
danielk1977e3026632004-06-22 11:29:02 +00002198#endif