blob: 01a070b96e9d6aa13dbac2015f01db405783cb3e [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**
drh7209c692008-04-27 18:40:11 +000014** @(#) $Id: sqliteInt.h,v 1.696 2008/04/27 18:40:12 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/*
drhc5499be2008-04-01 15:06:33 +000039** A macro used to aid in coverage testing. When doing coverage
40** testing, the condition inside the argument must be evaluated
41** both true and false in order to get full branch coverage.
42** This macro can be inserted to ensure adequate test coverage
43** in places where simple condition/decision coverage is inadequate.
44*/
45#ifdef SQLITE_COVERAGE_TEST
46 void sqlite3Coverage(int);
47# define testcase(X) if( X ){ sqlite3Coverage(__LINE__); }
48#else
49# define testcase(X)
50#endif
51
mlcreech98dc4b12008-03-06 16:28:58 +000052
drh71674ce2007-10-23 15:51:26 +000053/*
drhb6dbc002007-11-27 02:38:00 +000054** The macro unlikely() is a hint that surrounds a boolean
55** expression that is usually false. Macro likely() surrounds
56** a boolean expression that is usually true. GCC is able to
57** use these hints to generate better code, sometimes.
58*/
drh4bbf4642008-01-30 16:14:23 +000059#if defined(__GNUC__) && 0
drhb6dbc002007-11-27 02:38:00 +000060# define likely(X) __builtin_expect((X),1)
61# define unlikely(X) __builtin_expect((X),0)
62#else
63# define likely(X) !!(X)
64# define unlikely(X) !!(X)
65#endif
66
67
68/*
drh71674ce2007-10-23 15:51:26 +000069** These #defines should enable >2GB file support on Posix if the
70** underlying operating system supports it. If the OS lacks
71** large file support, or if the OS is windows, these should be no-ops.
72**
73** Ticket #2739: The _LARGEFILE_SOURCE macro must appear before any
74** system #includes. Hence, this block of code must be the very first
75** code in all source files.
76**
77** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
78** on the compiler command line. This is necessary if you are compiling
79** on a recent machine (ex: RedHat 7.2) but you want your code to work
80** on an older machine (ex: RedHat 6.0). If you compile on RedHat 7.2
81** without this option, LFS is enable. But LFS does not exist in the kernel
82** in RedHat 6.0, so the code won't work. Hence, for maximum binary
83** portability you should omit LFS.
84**
85** Similar is true for MacOS. LFS is only supported on MacOS 9 and later.
86*/
87#ifndef SQLITE_DISABLE_LFS
88# define _LARGE_FILE 1
89# ifndef _FILE_OFFSET_BITS
90# define _FILE_OFFSET_BITS 64
91# endif
92# define _LARGEFILE_SOURCE 1
93#endif
94
95
drhe5e7a902007-10-01 17:47:00 +000096/*
97** The SQLITE_THREADSAFE macro must be defined as either 0 or 1.
98** Older versions of SQLite used an optional THREADSAFE macro.
99** We support that for legacy
100*/
101#if !defined(SQLITE_THREADSAFE)
102#if defined(THREADSAFE)
103# define SQLITE_THREADSAFE THREADSAFE
104#else
105# define SQLITE_THREADSAFE 1
106#endif
107#endif
108
drh67080612007-10-01 14:30:14 +0000109/*
drh0d180202008-02-14 23:26:56 +0000110** Exactly one of the following macros must be defined in order to
111** specify which memory allocation subsystem to use.
112**
113** SQLITE_SYSTEM_MALLOC // Use normal system malloc()
114** SQLITE_MEMDEBUG // Debugging version of system malloc()
115** SQLITE_MEMORY_SIZE // internal allocator #1
116** SQLITE_MMAP_HEAP_SIZE // internal mmap() allocator
117** SQLITE_POW2_MEMORY_SIZE // internal power-of-two allocator
118**
119** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as
120** the default.
121*/
122#if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\
123 defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\
124 defined(SQLITE_POW2_MEMORY_SIZE)>1
125# error "At most one of the following compile-time configuration options\
126 is allows: SQLITE_SYSTEM_MALLOC, SQLITE_MEMDEBUG, SQLITE_MEMORY_SIZE,\
127 SQLITE_MMAP_HEAP_SIZE, SQLITE_POW2_MEMORY_SIZE"
128#endif
129#if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\
130 defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\
131 defined(SQLITE_POW2_MEMORY_SIZE)==0
132# define SQLITE_SYSTEM_MALLOC 1
133#endif
134
135/*
drheee4c8c2008-02-18 22:24:57 +0000136** If SQLITE_MALLOC_SOFT_LIMIT is defined, then try to keep the
137** sizes of memory allocations below this value where possible.
138*/
139#if defined(SQLITE_POW2_MEMORY_SIZE) && !defined(SQLITE_MALLOC_SOFT_LIMIT)
140# define SQLITE_MALLOC_SOFT_LIMIT 1024
141#endif
142
143/*
drh67080612007-10-01 14:30:14 +0000144** We need to define _XOPEN_SOURCE as follows in order to enable
145** recursive mutexes on most unix systems. But Mac OS X is different.
146** The _XOPEN_SOURCE define causes problems for Mac OS X we are told,
147** so it is omitted there. See ticket #2673.
drhe5e7a902007-10-01 17:47:00 +0000148**
149** Later we learn that _XOPEN_SOURCE is poorly or incorrectly
150** implemented on some systems. So we avoid defining it at all
151** if it is already defined or if it is unneeded because we are
152** not doing a threadsafe build. Ticket #2681.
drh9e0ebbf2007-10-23 15:59:18 +0000153**
154** See also ticket #2741.
drh67080612007-10-01 14:30:14 +0000155*/
aswiftee99b902008-01-28 22:09:23 +0000156#if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__) && SQLITE_THREADSAFE
drh67080612007-10-01 14:30:14 +0000157# define _XOPEN_SOURCE 500 /* Needed to enable pthread recursive mutexes */
158#endif
danielk1977e3026632004-06-22 11:29:02 +0000159
drh4f0c5872007-03-26 22:05:01 +0000160#if defined(SQLITE_TCL) || defined(TCLSH)
161# include <tcl.h>
drh824d7c12006-01-06 12:03:19 +0000162#endif
163
164/*
drh4b529d92005-09-13 00:00:00 +0000165** Many people are failing to set -DNDEBUG=1 when compiling SQLite.
drhb27795c2005-09-13 00:02:16 +0000166** Setting NDEBUG makes the code smaller and run faster. So the following
drh4b529d92005-09-13 00:00:00 +0000167** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1
168** option is set. Thus NDEBUG becomes an opt-in rather than an opt-out
169** feature.
170*/
danielk1977771151b2006-01-17 13:21:40 +0000171#if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
drh4b529d92005-09-13 00:00:00 +0000172# define NDEBUG 1
173#endif
174
drh1d482dd2004-05-31 18:23:07 +0000175#include "sqlite3.h"
drhbeae3192001-09-22 18:12:08 +0000176#include "hash.h"
drh75897232000-05-29 14:26:00 +0000177#include "parse.h"
drh75897232000-05-29 14:26:00 +0000178#include <stdio.h>
179#include <stdlib.h>
180#include <string.h>
181#include <assert.h>
drh52370e22005-01-21 21:31:40 +0000182#include <stddef.h>
drh75897232000-05-29 14:26:00 +0000183
drh7cd69272007-06-20 15:29:25 +0000184#define sqlite3_isnan(X) ((X)!=(X))
drh7361cb12007-06-10 22:57:33 +0000185
drh967e8b72000-06-21 13:59:10 +0000186/*
drhb37df7b2005-10-13 02:09:49 +0000187** If compiling for a processor that lacks floating point support,
188** substitute integer for floating-point
189*/
190#ifdef SQLITE_OMIT_FLOATING_POINT
191# define double sqlite_int64
192# define LONGDOUBLE_TYPE sqlite_int64
drhd1167392006-01-23 13:00:35 +0000193# ifndef SQLITE_BIG_DBL
194# define SQLITE_BIG_DBL (0x7fffffffffffffff)
195# endif
drhb37df7b2005-10-13 02:09:49 +0000196# define SQLITE_OMIT_DATETIME_FUNCS 1
197# define SQLITE_OMIT_TRACE 1
drh110daac2007-05-04 11:59:31 +0000198# undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
drhb37df7b2005-10-13 02:09:49 +0000199#endif
drhd1167392006-01-23 13:00:35 +0000200#ifndef SQLITE_BIG_DBL
201# define SQLITE_BIG_DBL (1e99)
202#endif
drhb37df7b2005-10-13 02:09:49 +0000203
204/*
danielk197753c0f742005-03-29 03:10:59 +0000205** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
206** afterward. Having this macro allows us to cause the C compiler
207** to omit code used by TEMP tables without messy #ifndef statements.
208*/
209#ifdef SQLITE_OMIT_TEMPDB
210#define OMIT_TEMPDB 1
211#else
212#define OMIT_TEMPDB 0
213#endif
214
215/*
drh0bd1f4e2002-06-06 18:54:39 +0000216** If the following macro is set to 1, then NULL values are considered
drh0bd1f4e2002-06-06 18:54:39 +0000217** distinct when determining whether or not two entries are the same
218** in a UNIQUE index. This is the way PostgreSQL, Oracle, DB2, MySQL,
219** OCELOT, and Firebird all work. The SQL92 spec explicitly says this
220** is the way things are suppose to work.
221**
222** If the following macro is set to 0, the NULLs are indistinct for
223** a UNIQUE index. In this mode, you can only have a single NULL entry
224** for a column declared UNIQUE. This is the way Informix and SQL Server
225** work.
226*/
227#define NULL_DISTINCT_FOR_UNIQUE 1
228
229/*
drhd946db02005-12-29 19:23:06 +0000230** The "file format" number is an integer that is incremented whenever
231** the VDBE-level file format changes. The following macros define the
232** the default file format for new databases and the maximum file format
233** that the library can read.
234*/
235#define SQLITE_MAX_FILE_FORMAT 4
236#ifndef SQLITE_DEFAULT_FILE_FORMAT
drh76fe8032006-07-11 14:17:51 +0000237# define SQLITE_DEFAULT_FILE_FORMAT 1
drhd946db02005-12-29 19:23:06 +0000238#endif
239
240/*
drh49766d62005-01-08 18:42:28 +0000241** Provide a default value for TEMP_STORE in case it is not specified
242** on the command-line
243*/
244#ifndef TEMP_STORE
245# define TEMP_STORE 1
246#endif
247
248/*
drhf1974842004-11-05 03:56:00 +0000249** GCC does not define the offsetof() macro so we'll have to do it
250** ourselves.
251*/
252#ifndef offsetof
253#define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
254#endif
255
256/*
drh9b8f4472006-04-04 01:54:55 +0000257** Check to see if this machine uses EBCDIC. (Yes, believe it or
258** not, there are still machines out there that use EBCDIC.)
259*/
260#if 'A' == '\301'
261# define SQLITE_EBCDIC 1
262#else
263# define SQLITE_ASCII 1
264#endif
265
266/*
drh5a2c2c22001-11-21 02:21:11 +0000267** Integers of known sizes. These typedefs might change for architectures
268** where the sizes very. Preprocessor macros are available so that the
269** types can be conveniently redefined at compile-type. Like this:
270**
271** cc '-DUINTPTR_TYPE=long long int' ...
drh41a2b482001-01-20 19:52:49 +0000272*/
drh5a2c2c22001-11-21 02:21:11 +0000273#ifndef UINT32_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000274# ifdef HAVE_UINT32_T
275# define UINT32_TYPE uint32_t
276# else
277# define UINT32_TYPE unsigned int
278# endif
drh5a2c2c22001-11-21 02:21:11 +0000279#endif
280#ifndef UINT16_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000281# ifdef HAVE_UINT16_T
282# define UINT16_TYPE uint16_t
283# else
284# define UINT16_TYPE unsigned short int
285# endif
drh5a2c2c22001-11-21 02:21:11 +0000286#endif
drh939a16d2004-07-15 13:37:22 +0000287#ifndef INT16_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000288# ifdef HAVE_INT16_T
289# define INT16_TYPE int16_t
290# else
291# define INT16_TYPE short int
292# endif
drh939a16d2004-07-15 13:37:22 +0000293#endif
drh5a2c2c22001-11-21 02:21:11 +0000294#ifndef UINT8_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000295# ifdef HAVE_UINT8_T
296# define UINT8_TYPE uint8_t
297# else
298# define UINT8_TYPE unsigned char
299# endif
drh5a2c2c22001-11-21 02:21:11 +0000300#endif
drh905793e2004-02-21 13:31:09 +0000301#ifndef INT8_TYPE
mlcreechdda5b682008-03-14 13:02:08 +0000302# ifdef HAVE_INT8_T
303# define INT8_TYPE int8_t
304# else
305# define INT8_TYPE signed char
306# endif
drh905793e2004-02-21 13:31:09 +0000307#endif
drhefad9992004-06-22 12:13:55 +0000308#ifndef LONGDOUBLE_TYPE
309# define LONGDOUBLE_TYPE long double
310#endif
drhefad9992004-06-22 12:13:55 +0000311typedef sqlite_int64 i64; /* 8-byte signed integer */
drh27436af2006-03-28 23:57:17 +0000312typedef sqlite_uint64 u64; /* 8-byte unsigned integer */
drh5a2c2c22001-11-21 02:21:11 +0000313typedef UINT32_TYPE u32; /* 4-byte unsigned integer */
314typedef UINT16_TYPE u16; /* 2-byte unsigned integer */
drh939a16d2004-07-15 13:37:22 +0000315typedef INT16_TYPE i16; /* 2-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000316typedef UINT8_TYPE u8; /* 1-byte unsigned integer */
drh905793e2004-02-21 13:31:09 +0000317typedef UINT8_TYPE i8; /* 1-byte signed integer */
drh5a2c2c22001-11-21 02:21:11 +0000318
319/*
drhbbd42a62004-05-22 17:41:58 +0000320** Macros to determine whether the machine is big or little endian,
321** evaluated at runtime.
322*/
drh46c99e02007-08-27 23:26:59 +0000323#ifdef SQLITE_AMALGAMATION
mlcreech7ff4a452008-03-06 09:19:00 +0000324const int sqlite3one;
drh46c99e02007-08-27 23:26:59 +0000325#else
drhbbd42a62004-05-22 17:41:58 +0000326extern const int sqlite3one;
drh46c99e02007-08-27 23:26:59 +0000327#endif
drh38def052007-03-31 15:27:59 +0000328#if defined(i386) || defined(__i386__) || defined(_M_IX86)
329# define SQLITE_BIGENDIAN 0
330# define SQLITE_LITTLEENDIAN 1
331# define SQLITE_UTF16NATIVE SQLITE_UTF16LE
332#else
333# define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0)
334# define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
335# define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
336#endif
drhbbd42a62004-05-22 17:41:58 +0000337
338/*
drh90f5ecb2004-07-22 01:19:35 +0000339** An instance of the following structure is used to store the busy-handler
340** callback for a given sqlite handle.
341**
342** The sqlite.busyHandler member of the sqlite struct contains the busy
343** callback for the database handle. Each pager opened via the sqlite
344** handle is passed a pointer to sqlite.busyHandler. The busy-handler
345** callback is currently invoked only from within pager.c.
346*/
347typedef struct BusyHandler BusyHandler;
348struct BusyHandler {
349 int (*xFunc)(void *,int); /* The busy callback */
350 void *pArg; /* First arg to busy callback */
drha4afb652005-07-09 02:16:02 +0000351 int nBusy; /* Incremented with each busy call */
drh90f5ecb2004-07-22 01:19:35 +0000352};
353
354/*
drh75897232000-05-29 14:26:00 +0000355** Name of the master database table. The master database table
356** is a special table that holds the names and attributes of all
357** user tables and indices.
358*/
drhe0bc4042002-06-25 01:09:11 +0000359#define MASTER_NAME "sqlite_master"
360#define TEMP_MASTER_NAME "sqlite_temp_master"
drh75897232000-05-29 14:26:00 +0000361
362/*
danielk19778e150812004-05-10 01:17:37 +0000363** The root-page of the master database table.
364*/
365#define MASTER_ROOT 1
366
367/*
drhed6c8672003-01-12 18:02:16 +0000368** The name of the schema table.
369*/
danielk197753c0f742005-03-29 03:10:59 +0000370#define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
drhed6c8672003-01-12 18:02:16 +0000371
372/*
drh75897232000-05-29 14:26:00 +0000373** A convenience macro that returns the number of elements in
374** an array.
375*/
376#define ArraySize(X) (sizeof(X)/sizeof(X[0]))
377
378/*
379** Forward references to structures
380*/
drh13449892005-09-07 21:22:45 +0000381typedef struct AggInfo AggInfo;
drhfe05af82005-07-21 03:14:59 +0000382typedef struct AuthContext AuthContext;
drhf5e7bb52008-02-18 14:47:33 +0000383typedef struct Bitvec Bitvec;
drhfe05af82005-07-21 03:14:59 +0000384typedef struct CollSeq CollSeq;
drh7020f652000-06-03 18:06:52 +0000385typedef struct Column Column;
drhfe05af82005-07-21 03:14:59 +0000386typedef struct Db Db;
danielk1977e501b892006-01-09 06:29:47 +0000387typedef struct Schema Schema;
drh75897232000-05-29 14:26:00 +0000388typedef struct Expr Expr;
389typedef struct ExprList ExprList;
drhc2eef3b2002-08-31 18:53:06 +0000390typedef struct FKey FKey;
drhfe05af82005-07-21 03:14:59 +0000391typedef struct FuncDef FuncDef;
392typedef struct IdList IdList;
393typedef struct Index Index;
danielk19778d059842004-05-12 11:24:02 +0000394typedef struct KeyClass KeyClass;
drhd3d39e92004-05-20 22:16:29 +0000395typedef struct KeyInfo KeyInfo;
danielk1977d1ab1ba2006-06-15 04:28:13 +0000396typedef struct Module Module;
drh626a8792005-01-17 22:08:19 +0000397typedef struct NameContext NameContext;
drhfe05af82005-07-21 03:14:59 +0000398typedef struct Parse Parse;
399typedef struct Select Select;
400typedef struct SrcList SrcList;
drhade86482007-11-28 22:36:40 +0000401typedef struct StrAccum StrAccum;
drhfe05af82005-07-21 03:14:59 +0000402typedef struct Table Table;
danielk1977c00da102006-01-07 13:21:04 +0000403typedef struct TableLock TableLock;
drhfe05af82005-07-21 03:14:59 +0000404typedef struct Token Token;
405typedef struct TriggerStack TriggerStack;
406typedef struct TriggerStep TriggerStep;
407typedef struct Trigger Trigger;
drhfe05af82005-07-21 03:14:59 +0000408typedef struct WhereInfo WhereInfo;
409typedef struct WhereLevel WhereLevel;
drhd3d39e92004-05-20 22:16:29 +0000410
danielk19772dca4ac2008-01-03 11:50:29 +0000411/*
412** Defer sourcing vdbe.h and btree.h until after the "u8" and
413** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
414** pointer types (i.e. FuncDef) defined above.
415*/
416#include "btree.h"
417#include "vdbe.h"
418#include "pager.h"
419
danielk19771cc5ed82007-05-16 17:28:43 +0000420#include "os.h"
drhc7ce76a2007-08-30 14:10:30 +0000421#include "mutex.h"
danielk19771cc5ed82007-05-16 17:28:43 +0000422
drheee4c8c2008-02-18 22:24:57 +0000423
drh001bbcb2003-03-19 03:14:00 +0000424/*
425** Each database file to be accessed by the system is an instance
426** of the following structure. There are normally two of these structures
427** in the sqlite.aDb[] array. aDb[0] is the main database file and
drha69d9162003-04-17 22:57:53 +0000428** aDb[1] is the database file used to hold temporary tables. Additional
429** databases may be attached.
drh001bbcb2003-03-19 03:14:00 +0000430*/
431struct Db {
432 char *zName; /* Name of this database */
433 Btree *pBt; /* The B*Tree structure for this database file */
danielk1977da184232006-01-05 11:34:32 +0000434 u8 inTrans; /* 0: not writable. 1: Transaction. 2: Checkpoint */
435 u8 safety_level; /* How aggressive at synching data to disk */
danielk1977da184232006-01-05 11:34:32 +0000436 void *pAux; /* Auxiliary data. Usually NULL */
437 void (*xFreeAux)(void*); /* Routine to free pAux */
danielk1977e501b892006-01-09 06:29:47 +0000438 Schema *pSchema; /* Pointer to database schema (possibly shared) */
danielk1977da184232006-01-05 11:34:32 +0000439};
440
441/*
442** An instance of the following structure stores a database schema.
danielk1977a04a34f2007-04-16 15:06:25 +0000443**
444** If there are no virtual tables configured in this schema, the
445** Schema.db variable is set to NULL. After the first virtual table
446** has been added, it is set to point to the database connection
447** used to create the connection. Once a virtual table has been
448** added to the Schema structure and the Schema.db variable populated,
449** only that database connection may use the Schema to prepare
450** statements.
danielk1977da184232006-01-05 11:34:32 +0000451*/
danielk1977e501b892006-01-09 06:29:47 +0000452struct Schema {
drh001bbcb2003-03-19 03:14:00 +0000453 int schema_cookie; /* Database schema version number for this file */
drhd24cc422003-03-27 12:51:24 +0000454 Hash tblHash; /* All tables indexed by name */
455 Hash idxHash; /* All (named) indices indexed by name */
456 Hash trigHash; /* All triggers indexed by name */
457 Hash aFKey; /* Foreign keys indexed by to-table */
drh4794f732004-11-05 17:17:50 +0000458 Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */
danielk1977da184232006-01-05 11:34:32 +0000459 u8 file_format; /* Schema format version for this file */
drh8079a0d2006-01-12 17:20:50 +0000460 u8 enc; /* Text encoding used by this database */
danielk1977da184232006-01-05 11:34:32 +0000461 u16 flags; /* Flags associated with this schema */
danielk197714db2662006-01-09 16:12:04 +0000462 int cache_size; /* Number of pages to use in the cache */
danielk1977a04a34f2007-04-16 15:06:25 +0000463#ifndef SQLITE_OMIT_VIRTUALTABLE
464 sqlite3 *db; /* "Owner" connection. See comment above */
465#endif
drh001bbcb2003-03-19 03:14:00 +0000466};
drh75897232000-05-29 14:26:00 +0000467
468/*
drh8bf8dc92003-05-17 17:35:10 +0000469** These macros can be used to test, set, or clear bits in the
470** Db.flags field.
471*/
danielk1977da184232006-01-05 11:34:32 +0000472#define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))==(P))
473#define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))!=0)
474#define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->flags|=(P)
475#define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->flags&=~(P)
drh8bf8dc92003-05-17 17:35:10 +0000476
477/*
478** Allowed values for the DB.flags field.
479**
drh8bf8dc92003-05-17 17:35:10 +0000480** The DB_SchemaLoaded flag is set after the database schema has been
481** read into internal hash tables.
482**
483** DB_UnresetViews means that one or more views have column names that
484** have been filled out. If the schema changes, these column names might
485** changes and so the view will need to be reset.
486*/
drh124b27e2004-06-19 16:06:10 +0000487#define DB_SchemaLoaded 0x0001 /* The schema has been loaded */
488#define DB_UnresetViews 0x0002 /* Some views have defined column names */
danielk1977b82e7ed2006-01-11 14:09:31 +0000489#define DB_Empty 0x0004 /* The file is empty (length 0 bytes) */
drh8bf8dc92003-05-17 17:35:10 +0000490
drhcaa639f2008-03-20 00:32:20 +0000491/*
492** The number of different kinds of things that can be limited
493** using the sqlite3_limit() interface.
494*/
495#define SQLITE_N_LIMIT (SQLITE_LIMIT_VARIABLE_NUMBER+1)
drh8bf8dc92003-05-17 17:35:10 +0000496
497/*
drhc9b84a12002-06-20 11:36:48 +0000498** Each database is an instance of the following structure.
499**
rdcb0c374f2004-02-20 22:53:38 +0000500** The sqlite.lastRowid records the last insert rowid generated by an
501** insert statement. Inserts on views do not affect its value. Each
502** trigger has its own context, so that lastRowid can be updated inside
503** triggers as usual. The previous value will be restored once the trigger
504** exits. Upon entering a before or instead of trigger, lastRowid is no
505** longer (since after version 2.8.12) reset to -1.
506**
507** The sqlite.nChange does not count changes within triggers and keeps no
danielk19776f8a5032004-05-10 10:34:51 +0000508** context. It is reset at start of sqlite3_exec.
rdcb0c374f2004-02-20 22:53:38 +0000509** The sqlite.lsChange represents the number of changes made by the last
510** insert, update, or delete statement. It remains constant throughout the
511** length of a statement and is then updated by OP_SetCounts. It keeps a
512** context stack just like lastRowid so that the count of changes
513** within a trigger is not seen outside the trigger. Changes to views do not
514** affect the value of lsChange.
515** The sqlite.csChange keeps track of the number of current changes (since
516** the last statement) and is used to update sqlite_lsChange.
danielk19776622cce2004-05-20 11:00:52 +0000517**
518** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
519** store the most recent error code and, if applicable, string. The
520** internal function sqlite3Error() is used to set these variables
521** consistently.
drh75897232000-05-29 14:26:00 +0000522*/
drh9bb575f2004-09-06 17:24:11 +0000523struct sqlite3 {
drh90f6a5b2007-08-15 13:04:54 +0000524 sqlite3_vfs *pVfs; /* OS Interface */
drh001bbcb2003-03-19 03:14:00 +0000525 int nDb; /* Number of backends currently in use */
526 Db *aDb; /* All backends */
drh5e00f6c2001-09-13 13:46:56 +0000527 int flags; /* Miscellanous flags. See below */
drh33f4e022007-09-03 15:19:34 +0000528 int openFlags; /* Flags passed to sqlite3_vfs.xOpen() */
drhfcd35c72005-05-21 02:48:08 +0000529 int errCode; /* Most recent error code (SQLITE_*) */
drh4ac285a2006-09-15 07:28:50 +0000530 int errMask; /* & result codes with this before returning */
drhfcd35c72005-05-21 02:48:08 +0000531 u8 autoCommit; /* The auto-commit flag. */
drh90f5ecb2004-07-22 01:19:35 +0000532 u8 temp_store; /* 1: file 2: memory 0: default */
drh17435752007-08-16 04:30:38 +0000533 u8 mallocFailed; /* True if we have seen a malloc failure */
drh3b020132008-04-17 17:02:01 +0000534 u8 dfltLockMode; /* Default locking-mode for attached dbs */
535 u8 dfltJournalMode; /* Default journal mode for attached dbs */
drh98757152008-01-09 23:04:12 +0000536 signed char nextAutovac; /* Autovac setting after VACUUM if >=0 */
danielk1977f653d782008-03-20 11:04:21 +0000537 int nextPagesize; /* Pagesize after VACUUM if >0 */
drh5e00f6c2001-09-13 13:46:56 +0000538 int nTable; /* Number of tables in the database */
drhd3d39e92004-05-20 22:16:29 +0000539 CollSeq *pDfltColl; /* The default collating sequence (BINARY) */
drhf328bc82004-05-10 23:29:49 +0000540 i64 lastRowid; /* ROWID of most recent insert (see above) */
541 i64 priorNewRowid; /* Last randomly generated ROWID */
drh247be432002-05-10 05:44:55 +0000542 int magic; /* Magic number for detect library misuse */
danielk1977b28af712004-06-21 06:50:26 +0000543 int nChange; /* Value returned by sqlite3_changes() */
544 int nTotalChange; /* Value returned by sqlite3_total_changes() */
drhd677b3d2007-08-20 22:48:41 +0000545 sqlite3_mutex *mutex; /* Connection mutex */
drhcaa639f2008-03-20 00:32:20 +0000546 int aLimit[SQLITE_N_LIMIT]; /* Limits */
danielk1977b28af712004-06-21 06:50:26 +0000547 struct sqlite3InitInfo { /* Information used during initialization */
548 int iDb; /* When back is being initialized */
549 int newTnum; /* Rootpage of table being initialized */
550 u8 busy; /* TRUE if currently initializing */
drh1d85d932004-02-14 23:05:52 +0000551 } init;
drhf1952c52006-06-08 15:48:00 +0000552 int nExtension; /* Number of loaded extensions */
drh761df872006-12-21 01:29:22 +0000553 void **aExtension; /* Array of shared libraray handles */
drh326dce72003-01-29 14:06:07 +0000554 struct Vdbe *pVdbe; /* List of active virtual machines */
danielk19771d850a72004-05-31 08:26:49 +0000555 int activeVdbeCnt; /* Number of vdbes currently executing */
drh19e2d372005-08-29 23:00:03 +0000556 void (*xTrace)(void*,const char*); /* Trace function */
557 void *pTraceArg; /* Argument to the trace function */
558 void (*xProfile)(void*,const char*,u64); /* Profiling function */
559 void *pProfileArg; /* Argument to profile function */
danielk197771fd80b2005-12-16 06:54:01 +0000560 void *pCommitArg; /* Argument to xCommitCallback() */
561 int (*xCommitCallback)(void*); /* Invoked at every commit. */
562 void *pRollbackArg; /* Argument to xRollbackCallback() */
563 void (*xRollbackCallback)(void*); /* Invoked at every commit. */
danielk197794eb6a12005-12-15 15:22:08 +0000564 void *pUpdateArg;
565 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
drhfcd35c72005-05-21 02:48:08 +0000566 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
567 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
568 void *pCollNeededArg;
drhfcd35c72005-05-21 02:48:08 +0000569 sqlite3_value *pErr; /* Most recent error message */
570 char *zErrMsg; /* Most recent error message (UTF-8 encoded) */
571 char *zErrMsg16; /* Most recent error message (UTF-16 encoded) */
drh881feaa2006-07-26 01:39:30 +0000572 union {
573 int isInterrupted; /* True if sqlite3_interrupt has been called */
574 double notUsed1; /* Spacer */
575 } u1;
drhed6c8672003-01-12 18:02:16 +0000576#ifndef SQLITE_OMIT_AUTHORIZATION
drhe22a3342003-04-22 20:30:37 +0000577 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
578 /* Access authorization function */
drhed6c8672003-01-12 18:02:16 +0000579 void *pAuthArg; /* 1st argument to the access auth function */
580#endif
danielk1977348bb5d2003-10-18 09:37:26 +0000581#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
582 int (*xProgress)(void *); /* The progress callback */
583 void *pProgressArg; /* Argument to the progress callback */
584 int nProgressOps; /* Number of opcodes for progress callback */
585#endif
drhb9bb7c12006-06-11 23:41:55 +0000586#ifndef SQLITE_OMIT_VIRTUALTABLE
587 Hash aModule; /* populated by sqlite3_create_module() */
danielk19777e6ebfb2006-06-12 11:24:37 +0000588 Table *pVTab; /* vtab with active Connect/Create method */
danielk1977f9e7dda2006-06-16 16:08:53 +0000589 sqlite3_vtab **aVTrans; /* Virtual tables with open transactions */
590 int nVTrans; /* Allocated size of aVTrans */
danielk19776b456a22005-03-21 04:04:02 +0000591#endif
drhfcd35c72005-05-21 02:48:08 +0000592 Hash aFunc; /* All functions that can be in SQL exprs */
593 Hash aCollSeq; /* All collating sequences */
594 BusyHandler busyHandler; /* Busy callback */
drhb9bb7c12006-06-11 23:41:55 +0000595 int busyTimeout; /* Busy handler timeout, in msec */
drhfcd35c72005-05-21 02:48:08 +0000596 Db aDbStatic[2]; /* Static space for the 2 default backends */
danielk19777e900ab2005-05-23 04:51:01 +0000597#ifdef SQLITE_SSE
598 sqlite3_stmt *pFetch; /* Used by SSE to fetch stored statements */
599#endif
drh75897232000-05-29 14:26:00 +0000600};
601
drh03b808a2006-03-13 15:06:05 +0000602/*
603** A macro to discover the encoding of a database.
604*/
danielk197714db2662006-01-09 16:12:04 +0000605#define ENC(db) ((db)->aDb[0].pSchema->enc)
606
drh75897232000-05-29 14:26:00 +0000607/*
drh8bf8dc92003-05-17 17:35:10 +0000608** Possible values for the sqlite.flags and or Db.flags fields.
609**
610** On sqlite.flags, the SQLITE_InTrans value means that we have
611** executed a BEGIN. On Db.flags, SQLITE_InTrans means a statement
612** transaction is active on that particular database file.
drh75897232000-05-29 14:26:00 +0000613*/
drh5e00f6c2001-09-13 13:46:56 +0000614#define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */
drh5e00f6c2001-09-13 13:46:56 +0000615#define SQLITE_InTrans 0x00000008 /* True if in a transaction */
616#define SQLITE_InternChanges 0x00000010 /* Uncommitted Hash table changes */
drh382c0242001-10-06 16:33:02 +0000617#define SQLITE_FullColNames 0x00000020 /* Show full column names on SELECT */
drhfcabd462004-02-20 14:50:58 +0000618#define SQLITE_ShortColNames 0x00000040 /* Show short columns names */
619#define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */
drh1bee3d72001-10-15 00:44:35 +0000620 /* DELETE, or UPDATE and return */
621 /* the count using a callback. */
drhfcabd462004-02-20 14:50:58 +0000622#define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */
drh6a535342001-10-19 16:44:56 +0000623 /* result set is empty */
drh35d4c2f2004-06-10 01:30:59 +0000624#define SQLITE_SqlTrace 0x00000200 /* Debug print SQL as it executes */
625#define SQLITE_VdbeListing 0x00000400 /* Debug listings of VDBE programs */
drhf4040832004-10-22 20:29:21 +0000626#define SQLITE_WriteSchema 0x00000800 /* OK to update SQLITE_MASTER */
drh7bec5052005-02-06 02:45:41 +0000627#define SQLITE_NoReadlock 0x00001000 /* Readlocks are omitted when
628 ** accessing read-only databases */
drh0cd2d4c2005-11-03 02:15:02 +0000629#define SQLITE_IgnoreChecks 0x00002000 /* Do not enforce check constraints */
drhc2e87a32006-06-27 15:16:14 +0000630#define SQLITE_ReadUncommitted 0x00004000 /* For shared-cache mode */
drhe321c292006-01-12 01:56:43 +0000631#define SQLITE_LegacyFileFmt 0x00008000 /* Create new databases in format 1 */
drhac530b12006-02-11 01:25:50 +0000632#define SQLITE_FullFSync 0x00010000 /* Use full fsync on the backend */
drhc2e87a32006-06-27 15:16:14 +0000633#define SQLITE_LoadExtension 0x00020000 /* Enable load_extension */
drh58b95762000-06-02 01:17:37 +0000634
danielk197734c68fb2007-03-14 15:37:04 +0000635#define SQLITE_RecoveryMode 0x00040000 /* Ignore schema errors */
drh4a50aac2007-08-23 02:47:53 +0000636#define SQLITE_SharedCache 0x00080000 /* Cache sharing is enabled */
637#define SQLITE_Vtab 0x00100000 /* There exists a virtual table */
danielk197734c68fb2007-03-14 15:37:04 +0000638
drh58b95762000-06-02 01:17:37 +0000639/*
drh247be432002-05-10 05:44:55 +0000640** Possible values for the sqlite.magic field.
641** The numbers are obtained at random and have no special meaning, other
642** than being distinct from one another.
643*/
644#define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */
645#define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */
drh7e8b8482008-01-23 03:03:05 +0000646#define SQLITE_MAGIC_SICK 0x4b771290 /* Error and awaiting close */
drh247be432002-05-10 05:44:55 +0000647#define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */
648#define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */
649
650/*
drh0bce8352002-02-28 00:41:10 +0000651** Each SQL function is defined by an instance of the following
652** structure. A pointer to this structure is stored in the sqlite.aFunc
drh8e0a2f92002-02-23 23:45:45 +0000653** hash table. When multiple functions have the same name, the hash table
654** points to a linked list of these structures.
drh28037572000-08-02 13:47:41 +0000655*/
drh0bce8352002-02-28 00:41:10 +0000656struct FuncDef {
drh55ef4d92005-08-14 01:20:37 +0000657 i16 nArg; /* Number of arguments. -1 means unlimited */
danielk1977d8123362004-06-12 09:25:12 +0000658 u8 iPrefEnc; /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
drh55ef4d92005-08-14 01:20:37 +0000659 u8 needCollSeq; /* True if sqlite3GetFuncCollSeq() might be called */
660 u8 flags; /* Some combination of SQLITE_FUNC_* */
drhf9b596e2004-05-26 16:54:42 +0000661 void *pUserData; /* User data parameter */
662 FuncDef *pNext; /* Next function with same name */
663 void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
664 void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
665 void (*xFinalize)(sqlite3_context*); /* Aggregate finializer */
drh55ef4d92005-08-14 01:20:37 +0000666 char zName[1]; /* SQL name of the function. MUST BE LAST */
drh8e0a2f92002-02-23 23:45:45 +0000667};
drh28037572000-08-02 13:47:41 +0000668
669/*
danielk1977d1ab1ba2006-06-15 04:28:13 +0000670** Each SQLite module (virtual table definition) is defined by an
671** instance of the following structure, stored in the sqlite3.aModule
672** hash table.
673*/
674struct Module {
675 const sqlite3_module *pModule; /* Callback pointers */
676 const char *zName; /* Name passed to create_module() */
677 void *pAux; /* pAux passed to create_module() */
danielk1977832a58a2007-06-22 15:21:15 +0000678 void (*xDestroy)(void *); /* Module destructor function */
danielk1977d1ab1ba2006-06-15 04:28:13 +0000679};
680
681/*
drh55ef4d92005-08-14 01:20:37 +0000682** Possible values for FuncDef.flags
683*/
drhd64fe2f2005-08-28 17:00:23 +0000684#define SQLITE_FUNC_LIKE 0x01 /* Candidate for the LIKE optimization */
685#define SQLITE_FUNC_CASE 0x02 /* Case-sensitive LIKE-type function */
drhb7f6f682006-07-08 17:06:43 +0000686#define SQLITE_FUNC_EPHEM 0x04 /* Ephermeral. Delete with VDBE */
drh55ef4d92005-08-14 01:20:37 +0000687
688/*
drh967e8b72000-06-21 13:59:10 +0000689** information about each column of an SQL table is held in an instance
drh7020f652000-06-03 18:06:52 +0000690** of this structure.
691*/
692struct Column {
drh967e8b72000-06-21 13:59:10 +0000693 char *zName; /* Name of this column */
danielk19777977a172004-11-09 12:44:37 +0000694 Expr *pDflt; /* Default value of this column */
drh382c0242001-10-06 16:33:02 +0000695 char *zType; /* Data type for this column */
danielk1977b3bf5562006-01-10 17:58:23 +0000696 char *zColl; /* Collating sequence. If NULL, use the default */
drh4a324312001-12-21 14:30:42 +0000697 u8 notNull; /* True if there is a NOT NULL constraint */
drh78100cc2003-08-23 22:40:53 +0000698 u8 isPrimKey; /* True if this column is part of the PRIMARY KEY */
danielk1977a37cdde2004-05-16 11:15:36 +0000699 char affinity; /* One of the SQLITE_AFF_... values */
danielk1977034ca142007-06-26 10:38:54 +0000700#ifndef SQLITE_OMIT_VIRTUALTABLE
701 u8 isHidden; /* True if this column is 'hidden' */
702#endif
drh7020f652000-06-03 18:06:52 +0000703};
704
705/*
drha9fd84b2004-05-18 23:21:35 +0000706** A "Collating Sequence" is defined by an instance of the following
danielk19770202b292004-06-09 09:55:16 +0000707** structure. Conceptually, a collating sequence consists of a name and
708** a comparison routine that defines the order of that sequence.
drha9fd84b2004-05-18 23:21:35 +0000709**
danielk19770202b292004-06-09 09:55:16 +0000710** There may two seperate implementations of the collation function, one
711** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
712** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
713** native byte order. When a collation sequence is invoked, SQLite selects
714** the version that will require the least expensive encoding
danielk1977b3bf5562006-01-10 17:58:23 +0000715** translations, if any.
danielk19770202b292004-06-09 09:55:16 +0000716**
717** The CollSeq.pUser member variable is an extra parameter that passed in
718** as the first argument to the UTF-8 comparison function, xCmp.
719** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
720** xCmp16.
721**
722** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
723** collating sequence is undefined. Indices built on an undefined
724** collating sequence may not be read or written.
drha9fd84b2004-05-18 23:21:35 +0000725*/
726struct CollSeq {
danielk1977a9808b32007-05-07 09:32:45 +0000727 char *zName; /* Name of the collating sequence, UTF-8 encoded */
728 u8 enc; /* Text encoding handled by xCmp() */
729 u8 type; /* One of the SQLITE_COLL_... values below */
730 void *pUser; /* First argument to xCmp() */
danielk19770202b292004-06-09 09:55:16 +0000731 int (*xCmp)(void*,int, const void*, int, const void*);
danielk1977a9808b32007-05-07 09:32:45 +0000732 void (*xDel)(void*); /* Destructor for pUser */
drha9fd84b2004-05-18 23:21:35 +0000733};
734
735/*
drhd64fe2f2005-08-28 17:00:23 +0000736** Allowed values of CollSeq flags:
737*/
738#define SQLITE_COLL_BINARY 1 /* The default memcmp() collating sequence */
739#define SQLITE_COLL_NOCASE 2 /* The built-in NOCASE collating sequence */
740#define SQLITE_COLL_REVERSE 3 /* The built-in REVERSE collating sequence */
741#define SQLITE_COLL_USER 0 /* Any other user-defined collating sequence */
742
743/*
drhd3d39e92004-05-20 22:16:29 +0000744** A sort order can be either ASC or DESC.
drh8e2ca022002-06-17 17:07:19 +0000745*/
drh8e2ca022002-06-17 17:07:19 +0000746#define SQLITE_SO_ASC 0 /* Sort in ascending order */
drhd3d39e92004-05-20 22:16:29 +0000747#define SQLITE_SO_DESC 1 /* Sort in ascending order */
drh8e2ca022002-06-17 17:07:19 +0000748
749/*
danielk1977a37cdde2004-05-16 11:15:36 +0000750** Column affinity types.
drh8a512562005-11-14 22:29:05 +0000751**
752** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
753** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve
754** the speed a little by number the values consecutively.
755**
756** But rather than start with 0 or 1, we begin with 'a'. That way,
757** when multiple affinity types are concatenated into a string and
drh66a51672008-01-03 00:01:23 +0000758** used as the P4 operand, they will be more readable.
drh8a512562005-11-14 22:29:05 +0000759**
760** Note also that the numeric types are grouped together so that testing
761** for a numeric type is a single comparison.
danielk1977a37cdde2004-05-16 11:15:36 +0000762*/
drh8a512562005-11-14 22:29:05 +0000763#define SQLITE_AFF_TEXT 'a'
764#define SQLITE_AFF_NONE 'b'
765#define SQLITE_AFF_NUMERIC 'c'
766#define SQLITE_AFF_INTEGER 'd'
767#define SQLITE_AFF_REAL 'e'
danielk1977a37cdde2004-05-16 11:15:36 +0000768
drh8a512562005-11-14 22:29:05 +0000769#define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC)
danielk1977a37cdde2004-05-16 11:15:36 +0000770
771/*
drh35573352008-01-08 23:54:25 +0000772** The SQLITE_AFF_MASK values masks off the significant bits of an
773** affinity value.
774*/
775#define SQLITE_AFF_MASK 0x67
776
777/*
778** Additional bit values that can be ORed with an affinity without
779** changing the affinity.
780*/
781#define SQLITE_JUMPIFNULL 0x08 /* jumps if either operand is NULL */
782#define SQLITE_NULLEQUAL 0x10 /* compare NULLs equal */
783#define SQLITE_STOREP2 0x80 /* Store result in reg[P2] rather than jump */
784
785/*
drh22f70c32002-02-18 01:17:00 +0000786** Each SQL table is represented in memory by an instance of the
787** following structure.
788**
drhd24cc422003-03-27 12:51:24 +0000789** Table.zName is the name of the table. The case of the original
drh22f70c32002-02-18 01:17:00 +0000790** CREATE TABLE statement is stored, but case is not significant for
791** comparisons.
792**
drhd24cc422003-03-27 12:51:24 +0000793** Table.nCol is the number of columns in this table. Table.aCol is a
drh22f70c32002-02-18 01:17:00 +0000794** pointer to an array of Column structures, one for each column.
795**
drhd24cc422003-03-27 12:51:24 +0000796** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
797** the column that is that key. Otherwise Table.iPKey is negative. Note
drh22f70c32002-02-18 01:17:00 +0000798** that the datatype of the PRIMARY KEY must be INTEGER for this field to
799** be set. An INTEGER PRIMARY KEY is used as the rowid for each row of
800** the table. If a table has no INTEGER PRIMARY KEY, then a random rowid
drhd24cc422003-03-27 12:51:24 +0000801** is generated for each row of the table. Table.hasPrimKey is true if
drh22f70c32002-02-18 01:17:00 +0000802** the table has any PRIMARY KEY, INTEGER or otherwise.
803**
drhd24cc422003-03-27 12:51:24 +0000804** Table.tnum is the page number for the root BTree page of the table in the
805** database file. If Table.iDb is the index of the database table backend
806** in sqlite.aDb[]. 0 is for the main database and 1 is for the file that
drhb9bb7c12006-06-11 23:41:55 +0000807** holds temporary tables and indices. If Table.isEphem
drh22f70c32002-02-18 01:17:00 +0000808** is true, then the table is stored in a file that is automatically deleted
drhd24cc422003-03-27 12:51:24 +0000809** when the VDBE cursor to the table is closed. In this case Table.tnum
drh22f70c32002-02-18 01:17:00 +0000810** refers VDBE cursor number that holds the table open, not to the root
811** page number. Transient tables are used to hold the results of a
812** sub-query that appears instead of a real table name in the FROM clause
813** of a SELECT statement.
drh75897232000-05-29 14:26:00 +0000814*/
815struct Table {
drh967e8b72000-06-21 13:59:10 +0000816 char *zName; /* Name of the table */
drh967e8b72000-06-21 13:59:10 +0000817 int nCol; /* Number of columns in this table */
818 Column *aCol; /* Information about each column */
drhc8392582001-12-31 02:48:51 +0000819 int iPKey; /* If not less then 0, use aCol[iPKey] as the primary key */
drh967e8b72000-06-21 13:59:10 +0000820 Index *pIndex; /* List of SQL indexes on this table. */
drh22f70c32002-02-18 01:17:00 +0000821 int tnum; /* Root BTree node for this table (see note above) */
drha76b5df2002-02-23 02:32:10 +0000822 Select *pSelect; /* NULL for tables. Points to definition if a view. */
drhed8a3bb2005-06-06 21:19:56 +0000823 int nRef; /* Number of pointers to this Table */
danielk1977c3f9bad2002-05-15 08:30:12 +0000824 Trigger *pTrigger; /* List of SQL triggers on this table */
drhc2eef3b2002-08-31 18:53:06 +0000825 FKey *pFKey; /* Linked list of all foreign keys in this table */
danielk19773d1bfea2004-05-14 11:00:53 +0000826 char *zColAff; /* String defining the affinity of each column */
drhffe07b22005-11-03 00:41:17 +0000827#ifndef SQLITE_OMIT_CHECK
828 Expr *pCheck; /* The AND of all CHECK constraints */
829#endif
danielk197719a8e7e2005-03-17 05:03:38 +0000830#ifndef SQLITE_OMIT_ALTERTABLE
831 int addColOffset; /* Offset in CREATE TABLE statement to add a new column */
832#endif
drh19146192006-06-26 19:10:32 +0000833 u8 readOnly; /* True if this table should not be written by the user */
834 u8 isEphem; /* True if created using OP_OpenEphermeral */
835 u8 hasPrimKey; /* True if there exists a primary key */
836 u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */
837 u8 autoInc; /* True if the integer primary key is autoincrement */
drhe09daa92006-06-10 13:29:31 +0000838#ifndef SQLITE_OMIT_VIRTUALTABLE
drh19146192006-06-26 19:10:32 +0000839 u8 isVirtual; /* True if this is a virtual table */
840 u8 isCommit; /* True once the CREATE TABLE has been committed */
danielk1977d1ab1ba2006-06-15 04:28:13 +0000841 Module *pMod; /* Pointer to the implementation of the module */
drhb9bb7c12006-06-11 23:41:55 +0000842 sqlite3_vtab *pVtab; /* Pointer to the module instance */
843 int nModuleArg; /* Number of arguments to the module */
844 char **azModuleArg; /* Text of all module args. [0] is module name */
drhe09daa92006-06-10 13:29:31 +0000845#endif
drh728b5772007-09-18 15:55:07 +0000846 Schema *pSchema; /* Schema that contains this table */
drh75897232000-05-29 14:26:00 +0000847};
848
849/*
drh4cbdda92006-06-14 19:00:20 +0000850** Test to see whether or not a table is a virtual table. This is
851** done as a macro so that it will be optimized out when virtual
852** table support is omitted from the build.
853*/
854#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977034ca142007-06-26 10:38:54 +0000855# define IsVirtual(X) ((X)->isVirtual)
856# define IsHiddenColumn(X) ((X)->isHidden)
drh4cbdda92006-06-14 19:00:20 +0000857#else
danielk1977034ca142007-06-26 10:38:54 +0000858# define IsVirtual(X) 0
859# define IsHiddenColumn(X) 0
drh4cbdda92006-06-14 19:00:20 +0000860#endif
861
862/*
drhc2eef3b2002-08-31 18:53:06 +0000863** Each foreign key constraint is an instance of the following structure.
864**
865** A foreign key is associated with two tables. The "from" table is
866** the table that contains the REFERENCES clause that creates the foreign
867** key. The "to" table is the table that is named in the REFERENCES clause.
868** Consider this example:
869**
870** CREATE TABLE ex1(
871** a INTEGER PRIMARY KEY,
872** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
873** );
874**
875** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
876**
877** Each REFERENCES clause generates an instance of the following structure
878** which is attached to the from-table. The to-table need not exist when
879** the from-table is created. The existance of the to-table is not checked
880** until an attempt is made to insert data into the from-table.
881**
drhea1ba172003-04-20 00:00:23 +0000882** The sqlite.aFKey hash table stores pointers to this structure
drhc2eef3b2002-08-31 18:53:06 +0000883** given the name of a to-table. For each to-table, all foreign keys
884** associated with that table are on a linked list using the FKey.pNextTo
885** field.
886*/
887struct FKey {
888 Table *pFrom; /* The table that constains the REFERENCES clause */
889 FKey *pNextFrom; /* Next foreign key in pFrom */
890 char *zTo; /* Name of table that the key points to */
891 FKey *pNextTo; /* Next foreign key that points to zTo */
892 int nCol; /* Number of columns in this key */
893 struct sColMap { /* Mapping of columns in pFrom to columns in zTo */
894 int iFrom; /* Index of column in pFrom */
895 char *zCol; /* Name of column in zTo. If 0 use PRIMARY KEY */
896 } *aCol; /* One entry for each of nCol column s */
897 u8 isDeferred; /* True if constraint checking is deferred till COMMIT */
898 u8 updateConf; /* How to resolve conflicts that occur on UPDATE */
899 u8 deleteConf; /* How to resolve conflicts that occur on DELETE */
900 u8 insertConf; /* How to resolve conflicts that occur on INSERT */
901};
902
903/*
danielk1977aaa40c12007-09-21 04:28:16 +0000904** SQLite supports many different ways to resolve a constraint
drh22f70c32002-02-18 01:17:00 +0000905** error. ROLLBACK processing means that a constraint violation
drh0bd1f4e2002-06-06 18:54:39 +0000906** causes the operation in process to fail and for the current transaction
drh1c928532002-01-31 15:54:21 +0000907** to be rolled back. ABORT processing means the operation in process
908** fails and any prior changes from that one operation are backed out,
909** but the transaction is not rolled back. FAIL processing means that
910** the operation in progress stops and returns an error code. But prior
911** changes due to the same operation are not backed out and no rollback
912** occurs. IGNORE means that the particular row that caused the constraint
913** error is not inserted or updated. Processing continues and no error
914** is returned. REPLACE means that preexisting database rows that caused
915** a UNIQUE constraint violation are removed so that the new insert or
916** update can proceed. Processing continues and no error is reported.
drhc2eef3b2002-08-31 18:53:06 +0000917**
918** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
919** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
920** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign
921** key is set to NULL. CASCADE means that a DELETE or UPDATE of the
922** referenced table row is propagated into the row that holds the
923** foreign key.
drh1c928532002-01-31 15:54:21 +0000924**
drh968af522003-02-11 14:55:40 +0000925** The following symbolic values are used to record which type
drh1c928532002-01-31 15:54:21 +0000926** of action to take.
drh9cfcf5d2002-01-29 18:41:24 +0000927*/
drh1c928532002-01-31 15:54:21 +0000928#define OE_None 0 /* There is no constraint to check */
929#define OE_Rollback 1 /* Fail the operation and rollback the transaction */
930#define OE_Abort 2 /* Back out changes but do no rollback transaction */
931#define OE_Fail 3 /* Stop the operation but leave all prior changes */
932#define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */
933#define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */
drhc2eef3b2002-08-31 18:53:06 +0000934
935#define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
936#define OE_SetNull 7 /* Set the foreign key value to NULL */
937#define OE_SetDflt 8 /* Set the foreign key value to its default */
938#define OE_Cascade 9 /* Cascade the changes */
939
940#define OE_Default 99 /* Do whatever the default action is */
drh9cfcf5d2002-01-29 18:41:24 +0000941
drhd3d39e92004-05-20 22:16:29 +0000942
943/*
944** An instance of the following structure is passed as the first
945** argument to sqlite3VdbeKeyCompare and is used to control the
946** comparison of the two index keys.
947**
948** If the KeyInfo.incrKey value is true and the comparison would
drh7e627792005-04-29 02:10:00 +0000949** otherwise be equal, then return a result as if the second key
950** were larger.
drhd3d39e92004-05-20 22:16:29 +0000951*/
952struct KeyInfo {
drhb21c8cd2007-08-21 19:33:56 +0000953 sqlite3 *db; /* The database connection */
danielk1977b1bc9532004-05-22 03:05:33 +0000954 u8 enc; /* Text encoding - one of the TEXT_Utf* values */
drhd3d39e92004-05-20 22:16:29 +0000955 u8 incrKey; /* Increase 2nd key by epsilon before comparison */
danielk19779a96b662007-11-29 17:05:18 +0000956 u8 prefixIsEqual; /* Treat a prefix as equal */
drhd3d39e92004-05-20 22:16:29 +0000957 int nField; /* Number of entries in aColl[] */
drhd2d4a6b2006-01-10 15:18:27 +0000958 u8 *aSortOrder; /* If defined an aSortOrder[i] is true, sort DESC */
drhd3d39e92004-05-20 22:16:29 +0000959 CollSeq *aColl[1]; /* Collating sequence for each term of the key */
960};
961
drh9cfcf5d2002-01-29 18:41:24 +0000962/*
drh66b89c82000-11-28 20:47:17 +0000963** Each SQL index is represented in memory by an
drh75897232000-05-29 14:26:00 +0000964** instance of the following structure.
drh967e8b72000-06-21 13:59:10 +0000965**
966** The columns of the table that are to be indexed are described
967** by the aiColumn[] field of this structure. For example, suppose
968** we have the following table and index:
969**
970** CREATE TABLE Ex1(c1 int, c2 int, c3 text);
971** CREATE INDEX Ex2 ON Ex1(c3,c1);
972**
973** In the Table structure describing Ex1, nCol==3 because there are
974** three columns in the table. In the Index structure describing
975** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
976** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the
977** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
978** The second column to be indexed (c1) has an index of 0 in
979** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
drhea1ba172003-04-20 00:00:23 +0000980**
981** The Index.onError field determines whether or not the indexed columns
982** must be unique and what to do if they are not. When Index.onError=OE_None,
983** it means this is not a unique index. Otherwise it is a unique index
984** and the value of Index.onError indicate the which conflict resolution
985** algorithm to employ whenever an attempt is made to insert a non-unique
986** element.
drh75897232000-05-29 14:26:00 +0000987*/
988struct Index {
drh967e8b72000-06-21 13:59:10 +0000989 char *zName; /* Name of this index */
drh967e8b72000-06-21 13:59:10 +0000990 int nColumn; /* Number of columns in the table used by this index */
991 int *aiColumn; /* Which columns are used by this index. 1st is 0 */
drh8b3d9902005-08-19 00:14:42 +0000992 unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
drh967e8b72000-06-21 13:59:10 +0000993 Table *pTable; /* The SQL table being indexed */
drhbe0072d2001-09-13 14:46:09 +0000994 int tnum; /* Page containing root of this index in database file */
drh9cfcf5d2002-01-29 18:41:24 +0000995 u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
drh485b39b2002-07-13 03:11:52 +0000996 u8 autoIndex; /* True if is automatically created (ex: by UNIQUE) */
danielk1977a37cdde2004-05-16 11:15:36 +0000997 char *zColAff; /* String defining the affinity of each column */
drh967e8b72000-06-21 13:59:10 +0000998 Index *pNext; /* The next index associated with the same table */
danielk1977b3bf5562006-01-10 17:58:23 +0000999 Schema *pSchema; /* Schema containing this index */
1000 u8 *aSortOrder; /* Array of size Index.nColumn. True==DESC, False==ASC */
1001 char **azColl; /* Array of collation sequence names for index */
drh75897232000-05-29 14:26:00 +00001002};
1003
1004/*
1005** Each token coming out of the lexer is an instance of
drh4b59ab52002-08-24 18:24:51 +00001006** this structure. Tokens are also used as part of an expression.
drh4efc4752004-01-16 15:55:37 +00001007**
1008** Note if Token.z==0 then Token.dyn and Token.n are undefined and
1009** may contain random values. Do not make any assuptions about Token.dyn
1010** and Token.n when Token.z==0.
drh75897232000-05-29 14:26:00 +00001011*/
1012struct Token {
drh4c755c02004-08-08 20:22:17 +00001013 const unsigned char *z; /* Text of the token. Not NULL-terminated! */
1014 unsigned dyn : 1; /* True for malloced memory, false for static */
1015 unsigned n : 31; /* Number of characters in this token */
drh75897232000-05-29 14:26:00 +00001016};
1017
1018/*
drh13449892005-09-07 21:22:45 +00001019** An instance of this structure contains information needed to generate
1020** code for a SELECT that contains aggregate functions.
1021**
1022** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
1023** pointer to this structure. The Expr.iColumn field is the index in
1024** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
1025** code for that node.
1026**
1027** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
1028** original Select structure that describes the SELECT statement. These
1029** fields do not need to be freed when deallocating the AggInfo structure.
1030*/
1031struct AggInfo {
1032 u8 directMode; /* Direct rendering mode means take data directly
1033 ** from source tables rather than from accumulators */
1034 u8 useSortingIdx; /* In direct mode, reference the sorting index rather
1035 ** than the source table */
1036 int sortingIdx; /* Cursor number of the sorting index */
1037 ExprList *pGroupBy; /* The group by clause */
1038 int nSortingColumn; /* Number of columns in the sorting index */
1039 struct AggInfo_col { /* For each column used in source tables */
danielk19770817d0d2007-02-14 09:19:36 +00001040 Table *pTab; /* Source table */
drh13449892005-09-07 21:22:45 +00001041 int iTable; /* Cursor number of the source table */
1042 int iColumn; /* Column number within the source table */
1043 int iSorterColumn; /* Column number in the sorting index */
1044 int iMem; /* Memory location that acts as accumulator */
drh5774b802005-09-07 22:48:16 +00001045 Expr *pExpr; /* The original expression */
drh13449892005-09-07 21:22:45 +00001046 } *aCol;
1047 int nColumn; /* Number of used entries in aCol[] */
1048 int nColumnAlloc; /* Number of slots allocated for aCol[] */
1049 int nAccumulator; /* Number of columns that show through to the output.
1050 ** Additional columns are used only as parameters to
1051 ** aggregate functions */
1052 struct AggInfo_func { /* For each aggregate function */
1053 Expr *pExpr; /* Expression encoding the function */
1054 FuncDef *pFunc; /* The aggregate function implementation */
1055 int iMem; /* Memory location that acts as accumulator */
drhb9bb7c12006-06-11 23:41:55 +00001056 int iDistinct; /* Ephermeral table used to enforce DISTINCT */
drh13449892005-09-07 21:22:45 +00001057 } *aFunc;
1058 int nFunc; /* Number of entries in aFunc[] */
1059 int nFuncAlloc; /* Number of slots allocated for aFunc[] */
1060};
1061
1062/*
drh75897232000-05-29 14:26:00 +00001063** Each node of an expression in the parse tree is an instance
drh22f70c32002-02-18 01:17:00 +00001064** of this structure.
1065**
1066** Expr.op is the opcode. The integer parser token codes are reused
1067** as opcodes here. For example, the parser defines TK_GE to be an integer
1068** code representing the ">=" operator. This same integer code is reused
1069** to represent the greater-than-or-equal-to operator in the expression
1070** tree.
1071**
1072** Expr.pRight and Expr.pLeft are subexpressions. Expr.pList is a list
1073** of argument if the expression is a function.
1074**
drh4b59ab52002-08-24 18:24:51 +00001075** Expr.token is the operator token for this node. For some expressions
1076** that have subexpressions, Expr.token can be the complete text that gave
1077** rise to the Expr. In the latter case, the token is marked as being
1078** a compound token.
drh22f70c32002-02-18 01:17:00 +00001079**
1080** An expression of the form ID or ID.ID refers to a column in a table.
1081** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
1082** the integer cursor number of a VDBE cursor pointing to that table and
1083** Expr.iColumn is the column number for the specific column. If the
1084** expression is used as a result in an aggregate SELECT, then the
1085** value is also stored in the Expr.iAgg column in the aggregate so that
1086** it can be accessed after all aggregates are computed.
1087**
1088** If the expression is a function, the Expr.iTable is an integer code
drh7c972de2003-09-06 22:18:07 +00001089** representing which function. If the expression is an unbound variable
1090** marker (a question mark character '?' in the original SQL) then the
1091** Expr.iTable holds the index number for that variable.
drh22f70c32002-02-18 01:17:00 +00001092**
drh1398ad32005-01-19 23:24:50 +00001093** If the expression is a subquery then Expr.iColumn holds an integer
1094** register number containing the result of the subquery. If the
1095** subquery gives a constant result, then iTable is -1. If the subquery
1096** gives a different answer at different times during statement processing
1097** then iTable is the address of a subroutine that computes the subquery.
1098**
drh22f70c32002-02-18 01:17:00 +00001099** The Expr.pSelect field points to a SELECT statement. The SELECT might
1100** be the right operand of an IN operator. Or, if a scalar SELECT appears
1101** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
1102** operand.
danielk1977aee18ef2005-03-09 12:26:50 +00001103**
1104** If the Expr is of type OP_Column, and the table it is selecting from
1105** is a disk table or the "old.*" pseudo-table, then pTab points to the
1106** corresponding table definition.
drh75897232000-05-29 14:26:00 +00001107*/
1108struct Expr {
drh1cc093c2002-06-24 22:01:57 +00001109 u8 op; /* Operation performed by this node */
drha9fd84b2004-05-18 23:21:35 +00001110 char affinity; /* The affinity of the column or 0 if not a column */
drh6a03a1c2006-07-08 18:34:59 +00001111 u16 flags; /* Various flags. See below */
drhf2bc0132004-10-04 13:19:23 +00001112 CollSeq *pColl; /* The collation type of the column or 0 */
drh75897232000-05-29 14:26:00 +00001113 Expr *pLeft, *pRight; /* Left and right subnodes */
drhd99f7062002-06-08 23:25:08 +00001114 ExprList *pList; /* A list of expressions used as function arguments
1115 ** or in "<expr> IN (<expr-list)" */
drh75897232000-05-29 14:26:00 +00001116 Token token; /* An operand token */
drh6977fea2002-10-22 23:38:04 +00001117 Token span; /* Complete text of the expression */
drh967e8b72000-06-21 13:59:10 +00001118 int iTable, iColumn; /* When op==TK_COLUMN, then this expr node means the
drh8e2ca022002-06-17 17:07:19 +00001119 ** iColumn-th field of the iTable-th table. */
drh13449892005-09-07 21:22:45 +00001120 AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
1121 int iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
drh22d6a532005-09-19 21:05:48 +00001122 int iRightJoinTable; /* If EP_FromJoin, the right table of the join */
drhd99f7062002-06-08 23:25:08 +00001123 Select *pSelect; /* When the expression is a sub-select. Also the
1124 ** right side of "<expr> IN (<select>)" */
danielk1977aee18ef2005-03-09 12:26:50 +00001125 Table *pTab; /* Table for OP_Column expressions. */
drh728b5772007-09-18 15:55:07 +00001126/* Schema *pSchema; */
danielk1977e6a58a42007-08-31 17:42:48 +00001127#if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
danielk1977fc976062007-05-10 10:46:56 +00001128 int nHeight; /* Height of the tree headed by this node */
1129#endif
drh75897232000-05-29 14:26:00 +00001130};
1131
1132/*
drh1f162302002-10-27 19:35:33 +00001133** The following are the meanings of bits in the Expr.flags field.
1134*/
drh678ccce2008-03-31 18:19:54 +00001135#define EP_FromJoin 0x0001 /* Originated in ON or USING clause of a join */
1136#define EP_Agg 0x0002 /* Contains one or more aggregate functions */
1137#define EP_Resolved 0x0004 /* IDs have been resolved to COLUMNs */
1138#define EP_Error 0x0008 /* Expression contains one or more errors */
1139#define EP_Distinct 0x0010 /* Aggregate function with DISTINCT keyword */
1140#define EP_VarSelect 0x0020 /* pSelect is correlated, not constant */
1141#define EP_Dequoted 0x0040 /* True if the string has been dequoted */
1142#define EP_InfixFunc 0x0080 /* True for an infix function: LIKE, GLOB, etc */
1143#define EP_ExpCollate 0x0100 /* Collating sequence specified explicitly */
drhda250ea2008-04-01 05:07:14 +00001144#define EP_AnyAff 0x0200 /* Can take a cached column of any affinity */
drh47de9552008-04-01 18:04:11 +00001145#define EP_FixedDest 0x0400 /* Result needed in a specific register */
drh1f162302002-10-27 19:35:33 +00001146
1147/*
1148** These macros can be used to test, set, or clear bits in the
1149** Expr.flags field.
1150*/
1151#define ExprHasProperty(E,P) (((E)->flags&(P))==(P))
1152#define ExprHasAnyProperty(E,P) (((E)->flags&(P))!=0)
1153#define ExprSetProperty(E,P) (E)->flags|=(P)
1154#define ExprClearProperty(E,P) (E)->flags&=~(P)
1155
1156/*
drh75897232000-05-29 14:26:00 +00001157** A list of expressions. Each expression may optionally have a
1158** name. An expr/name combination can be used in several ways, such
1159** as the list of "expr AS ID" fields following a "SELECT" or in the
1160** list of "ID = expr" items in an UPDATE. A list of expressions can
drhad3cab52002-05-24 02:04:32 +00001161** also be used as the argument to a function, in which case the a.zName
drh75897232000-05-29 14:26:00 +00001162** field is not used.
1163*/
1164struct ExprList {
1165 int nExpr; /* Number of expressions on the list */
drh4305d102003-07-30 12:34:12 +00001166 int nAlloc; /* Number of entries allocated below */
drh9d2985c2005-09-08 01:58:42 +00001167 int iECursor; /* VDBE Cursor associated with this ExprList */
drh6d4abfb2001-10-22 02:58:08 +00001168 struct ExprList_item {
drh75897232000-05-29 14:26:00 +00001169 Expr *pExpr; /* The list of expressions */
1170 char *zName; /* Token associated with this expression */
drh8e2ca022002-06-17 17:07:19 +00001171 u8 sortOrder; /* 1 for DESC or 0 for ASC */
1172 u8 isAgg; /* True if this is an aggregate like count(*) */
1173 u8 done; /* A flag to indicate when processing is finished */
drh75897232000-05-29 14:26:00 +00001174 } *a; /* One entry for each expression */
1175};
1176
1177/*
drhad3cab52002-05-24 02:04:32 +00001178** An instance of this structure can hold a simple list of identifiers,
1179** such as the list "a,b,c" in the following statements:
1180**
1181** INSERT INTO t(a,b,c) VALUES ...;
1182** CREATE INDEX idx ON t(a,b,c);
1183** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1184**
1185** The IdList.a.idx field is used when the IdList represents the list of
1186** column names after a table name in an INSERT statement. In the statement
1187**
1188** INSERT INTO t(a,b,c) ...
1189**
1190** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
drh75897232000-05-29 14:26:00 +00001191*/
1192struct IdList {
drh6d4abfb2001-10-22 02:58:08 +00001193 struct IdList_item {
drhad3cab52002-05-24 02:04:32 +00001194 char *zName; /* Name of the identifier */
drh967e8b72000-06-21 13:59:10 +00001195 int idx; /* Index in some Table.aCol[] of a column named zName */
drhad3cab52002-05-24 02:04:32 +00001196 } *a;
drh13449892005-09-07 21:22:45 +00001197 int nId; /* Number of identifiers on the list */
1198 int nAlloc; /* Number of entries allocated for a[] below */
drhad3cab52002-05-24 02:04:32 +00001199};
1200
1201/*
drh51669862004-12-18 18:40:26 +00001202** The bitmask datatype defined below is used for various optimizations.
drhca83ac52007-02-01 01:40:44 +00001203**
1204** Changing this from a 64-bit to a 32-bit type limits the number of
1205** tables in a join to 32 instead of 64. But it also reduces the size
1206** of the library by 738 bytes on ix86.
drh51669862004-12-18 18:40:26 +00001207*/
drhca83ac52007-02-01 01:40:44 +00001208typedef u64 Bitmask;
drh51669862004-12-18 18:40:26 +00001209
1210/*
drhad3cab52002-05-24 02:04:32 +00001211** The following structure describes the FROM clause of a SELECT statement.
1212** Each table or subquery in the FROM clause is a separate element of
1213** the SrcList.a[] array.
drhd24cc422003-03-27 12:51:24 +00001214**
1215** With the addition of multiple database support, the following structure
1216** can also be used to describe a particular table such as the table that
1217** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL,
1218** such a table must be a simple name: ID. But in SQLite, the table can
1219** now be identified by a database name, a dot, then the table name: ID.ID.
drhc49de5d2007-01-19 01:06:01 +00001220**
1221** The jointype starts out showing the join type between the current table
1222** and the next table on the list. The parser builds the list this way.
1223** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
1224** jointype expresses the join between the table and the previous table.
drhad3cab52002-05-24 02:04:32 +00001225*/
1226struct SrcList {
drh939a16d2004-07-15 13:37:22 +00001227 i16 nSrc; /* Number of tables or subqueries in the FROM clause */
1228 i16 nAlloc; /* Number of entries allocated in a[] below */
drhad3cab52002-05-24 02:04:32 +00001229 struct SrcList_item {
drh113088e2003-03-20 01:16:58 +00001230 char *zDatabase; /* Name of database holding this table */
drhad3cab52002-05-24 02:04:32 +00001231 char *zName; /* Name of the table */
1232 char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */
drhdaffd0e2001-04-11 14:28:42 +00001233 Table *pTab; /* An SQL table corresponding to zName */
1234 Select *pSelect; /* A SELECT statement used in place of a table name */
danielk19771787cca2006-02-10 07:07:14 +00001235 u8 isPopulated; /* Temporary table associated with SELECT is populated */
drhc49de5d2007-01-19 01:06:01 +00001236 u8 jointype; /* Type of join between this able and the previous */
drhe68fbe72007-02-13 12:49:24 +00001237 int iCursor; /* The VDBE cursor number used to access this table */
drhad3cab52002-05-24 02:04:32 +00001238 Expr *pOn; /* The ON clause of a join */
1239 IdList *pUsing; /* The USING clause of a join */
drh51669862004-12-18 18:40:26 +00001240 Bitmask colUsed; /* Bit N (1<<N) set if column N or pTab is used */
drh113088e2003-03-20 01:16:58 +00001241 } a[1]; /* One entry for each identifier on the list */
drh75897232000-05-29 14:26:00 +00001242};
1243
1244/*
drh01f3f252002-05-24 16:14:15 +00001245** Permitted values of the SrcList.a.jointype field
1246*/
1247#define JT_INNER 0x0001 /* Any kind of inner or cross join */
drh3dec2232005-09-10 15:28:09 +00001248#define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */
1249#define JT_NATURAL 0x0004 /* True for a "natural" join */
1250#define JT_LEFT 0x0008 /* Left outer join */
1251#define JT_RIGHT 0x0010 /* Right outer join */
1252#define JT_OUTER 0x0020 /* The "OUTER" keyword is present */
1253#define JT_ERROR 0x0040 /* unknown or unsupported join type */
drh01f3f252002-05-24 16:14:15 +00001254
1255/*
drh6b563442001-11-07 16:48:26 +00001256** For each nested loop in a WHERE clause implementation, the WhereInfo
1257** structure contains a single instance of this structure. This structure
1258** is intended to be private the the where.c module and should not be
1259** access or modified by other modules.
drh6d209d82006-06-27 01:54:26 +00001260**
1261** The pIdxInfo and pBestIdx fields are used to help pick the best
1262** index on a virtual table. The pIdxInfo pointer contains indexing
1263** information for the i-th table in the FROM clause before reordering.
1264** All the pIdxInfo pointers are freed by whereInfoFree() in where.c.
1265** The pBestIdx pointer is a copy of pIdxInfo for the i-th table after
1266** FROM clause ordering. This is a little confusing so I will repeat
1267** it in different words. WhereInfo.a[i].pIdxInfo is index information
1268** for WhereInfo.pTabList.a[i]. WhereInfo.a[i].pBestInfo is the
1269** index information for the i-th loop of the join. pBestInfo is always
1270** either NULL or a copy of some pIdxInfo. So for cleanup it is
1271** sufficient to free all of the pIdxInfo pointers.
1272**
drh6b563442001-11-07 16:48:26 +00001273*/
1274struct WhereLevel {
drh29dda4a2005-07-21 18:23:20 +00001275 int iFrom; /* Which entry in the FROM clause */
1276 int flags; /* Flags associated with this level */
drh51147ba2005-07-23 22:59:55 +00001277 int iMem; /* First memory cell used by this level */
drh29dda4a2005-07-21 18:23:20 +00001278 int iLeftJoin; /* Memory cell used to implement LEFT OUTER JOIN */
1279 Index *pIdx; /* Index used. NULL if no index */
1280 int iTabCur; /* The VDBE cursor used to access the table */
1281 int iIdxCur; /* The VDBE cursor used to acesss pIdx */
1282 int brk; /* Jump here to break out of the loop */
drh72e8fa42007-03-28 14:30:06 +00001283 int nxt; /* Jump here to start the next IN combination */
drh29dda4a2005-07-21 18:23:20 +00001284 int cont; /* Jump here to continue with the next loop cycle */
1285 int top; /* First instruction of interior of the loop */
1286 int op, p1, p2; /* Opcode used to terminate the loop */
drh51147ba2005-07-23 22:59:55 +00001287 int nEq; /* Number of == or IN constraints on this loop */
drhe23399f2005-07-22 00:31:39 +00001288 int nIn; /* Number of IN operators constraining this loop */
drh72e8fa42007-03-28 14:30:06 +00001289 struct InLoop {
1290 int iCur; /* The VDBE cursor used by this IN operator */
1291 int topAddr; /* Top of the IN loop */
1292 } *aInLoop; /* Information about each nested IN operator */
drh6d209d82006-06-27 01:54:26 +00001293 sqlite3_index_info *pBestIdx; /* Index information for this level */
1294
1295 /* The following field is really not part of the current level. But
1296 ** we need a place to cache index information for each table in the
1297 ** FROM clause and the WhereLevel structure is a convenient place.
1298 */
1299 sqlite3_index_info *pIdxInfo; /* Index info for n-th source table */
drh6b563442001-11-07 16:48:26 +00001300};
1301
drh08c88eb2008-04-10 13:33:18 +00001302/*
1303** Flags appropriate for the wflags parameter of sqlite3WhereBegin().
1304*/
1305#define WHERE_ORDERBY_NORMAL 0 /* No-op */
1306#define WHERE_ORDERBY_MIN 1 /* ORDER BY processing for min() func */
1307#define WHERE_ORDERBY_MAX 2 /* ORDER BY processing for max() func */
1308#define WHERE_ONEPASS_DESIRED 4 /* Want to do one-pass UPDATE/DELETE */
danielk1977a9d1ccb2008-01-05 17:39:29 +00001309
drh6b563442001-11-07 16:48:26 +00001310/*
drh75897232000-05-29 14:26:00 +00001311** The WHERE clause processing routine has two halves. The
1312** first part does the start of the WHERE loop and the second
1313** half does the tail of the WHERE loop. An instance of
1314** this structure is returned by the first half and passed
1315** into the second half to give some continuity.
1316*/
1317struct WhereInfo {
drh08c88eb2008-04-10 13:33:18 +00001318 Parse *pParse; /* Parsing and code generating context */
1319 u8 okOnePass; /* Ok to use one-pass algorithm for UPDATE or DELETE */
drhad3cab52002-05-24 02:04:32 +00001320 SrcList *pTabList; /* List of tables in the join */
drh9012bcb2004-12-19 00:11:35 +00001321 int iTop; /* The very beginning of the WHERE loop */
drh19a775c2000-06-05 18:54:46 +00001322 int iContinue; /* Jump here to continue with next record */
1323 int iBreak; /* Jump here to break out of the loop */
drh6b563442001-11-07 16:48:26 +00001324 int nLevel; /* Number of nested loop */
drh6d209d82006-06-27 01:54:26 +00001325 sqlite3_index_info **apInfo; /* Array of pointers to index info structures */
drh6b563442001-11-07 16:48:26 +00001326 WhereLevel a[1]; /* Information about each nest loop in the WHERE */
drh75897232000-05-29 14:26:00 +00001327};
1328
1329/*
danielk1977b3bce662005-01-29 08:32:43 +00001330** A NameContext defines a context in which to resolve table and column
1331** names. The context consists of a list of tables (the pSrcList) field and
1332** a list of named expression (pEList). The named expression list may
1333** be NULL. The pSrc corresponds to the FROM clause of a SELECT or
1334** to the table being operated on by INSERT, UPDATE, or DELETE. The
1335** pEList corresponds to the result set of a SELECT and is NULL for
1336** other statements.
1337**
1338** NameContexts can be nested. When resolving names, the inner-most
1339** context is searched first. If no match is found, the next outer
1340** context is checked. If there is still no match, the next context
1341** is checked. This process continues until either a match is found
1342** or all contexts are check. When a match is found, the nRef member of
1343** the context containing the match is incremented.
1344**
1345** Each subquery gets a new NameContext. The pNext field points to the
1346** NameContext in the parent query. Thus the process of scanning the
1347** NameContext list corresponds to searching through successively outer
1348** subqueries looking for a match.
1349*/
1350struct NameContext {
1351 Parse *pParse; /* The parser */
1352 SrcList *pSrcList; /* One or more tables used to resolve names */
1353 ExprList *pEList; /* Optional list of named expressions */
1354 int nRef; /* Number of names resolved by this context */
1355 int nErr; /* Number of errors encountered while resolving names */
1356 u8 allowAgg; /* Aggregate functions allowed here */
drh13449892005-09-07 21:22:45 +00001357 u8 hasAgg; /* True if aggregates are seen */
drh06f65412005-11-03 02:03:13 +00001358 u8 isCheck; /* True if resolving names in a CHECK constraint */
danielk1977b3bce662005-01-29 08:32:43 +00001359 int nDepth; /* Depth of subquery recursion. 1 for no recursion */
drh13449892005-09-07 21:22:45 +00001360 AggInfo *pAggInfo; /* Information about aggregates at this level */
danielk1977b3bce662005-01-29 08:32:43 +00001361 NameContext *pNext; /* Next outer name context. NULL for outermost */
1362};
1363
1364/*
drh9bb61fe2000-06-05 16:01:39 +00001365** An instance of the following structure contains all information
1366** needed to generate code for a single SELECT statement.
drha76b5df2002-02-23 02:32:10 +00001367**
drhd11d3822002-06-21 23:01:49 +00001368** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0.
1369** If there is a LIMIT clause, the parser sets nLimit to the value of the
1370** limit and nOffset to the value of the offset (or 0 if there is not
1371** offset). But later on, nLimit and nOffset become the memory locations
1372** in the VDBE that record the limit and offset counters.
drh0342b1f2005-09-01 03:07:44 +00001373**
drhb9bb7c12006-06-11 23:41:55 +00001374** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
drh0342b1f2005-09-01 03:07:44 +00001375** These addresses must be stored so that we can go back and fill in
drh66a51672008-01-03 00:01:23 +00001376** the P4_KEYINFO and P2 parameters later. Neither the KeyInfo nor
drh0342b1f2005-09-01 03:07:44 +00001377** the number of columns in P2 can be computed at the same time
drhb9bb7c12006-06-11 23:41:55 +00001378** as the OP_OpenEphm instruction is coded because not
drh0342b1f2005-09-01 03:07:44 +00001379** enough information about the compound query is known at that point.
drhb9bb7c12006-06-11 23:41:55 +00001380** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
1381** for the result set. The KeyInfo for addrOpenTran[2] contains collating
drh0342b1f2005-09-01 03:07:44 +00001382** sequences for the ORDER BY clause.
drh9bb61fe2000-06-05 16:01:39 +00001383*/
1384struct Select {
drh9bb61fe2000-06-05 16:01:39 +00001385 ExprList *pEList; /* The fields of the result */
drh7b58dae2003-07-20 01:16:46 +00001386 u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
1387 u8 isDistinct; /* True if the DISTINCT keyword is present */
drh0342b1f2005-09-01 03:07:44 +00001388 u8 isResolved; /* True once sqlite3SelectResolve() has run. */
1389 u8 isAgg; /* True if this is an aggregate query */
drhb9bb7c12006-06-11 23:41:55 +00001390 u8 usesEphm; /* True if uses an OpenEphemeral opcode */
drh4b14b4d2005-09-19 17:35:53 +00001391 u8 disallowOrderBy; /* Do not allow an ORDER BY to be attached if TRUE */
drh6c1426f2007-04-12 03:54:38 +00001392 char affinity; /* MakeRecord with this affinity for SRT_Set */
drhad3cab52002-05-24 02:04:32 +00001393 SrcList *pSrc; /* The FROM clause */
drh9bb61fe2000-06-05 16:01:39 +00001394 Expr *pWhere; /* The WHERE clause */
1395 ExprList *pGroupBy; /* The GROUP BY clause */
1396 Expr *pHaving; /* The HAVING clause */
1397 ExprList *pOrderBy; /* The ORDER BY clause */
drh967e8b72000-06-21 13:59:10 +00001398 Select *pPrior; /* Prior select in a compound select statement */
drh1e281292007-12-13 03:45:07 +00001399 Select *pNext; /* Next select to the left in a compound */
drh0342b1f2005-09-01 03:07:44 +00001400 Select *pRightmost; /* Right-most select in a compound select statement */
danielk1977a2dc3b12005-02-05 12:48:48 +00001401 Expr *pLimit; /* LIMIT expression. NULL means not used. */
1402 Expr *pOffset; /* OFFSET expression. NULL means not used. */
drh7b58dae2003-07-20 01:16:46 +00001403 int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */
drhb9bb7c12006-06-11 23:41:55 +00001404 int addrOpenEphm[3]; /* OP_OpenEphem opcodes related to this select */
drh9bb61fe2000-06-05 16:01:39 +00001405};
1406
1407/*
drhfef52082000-06-06 01:50:43 +00001408** The results of a select can be distributed in several ways.
1409*/
drh13449892005-09-07 21:22:45 +00001410#define SRT_Union 1 /* Store result as keys in an index */
1411#define SRT_Except 2 /* Remove result from a UNION index */
danielk19779ed1dfa2008-01-02 17:11:14 +00001412#define SRT_Exists 3 /* Store 1 if the result is not empty */
1413#define SRT_Discard 4 /* Do not save the results anywhere */
drhfef52082000-06-06 01:50:43 +00001414
drh13449892005-09-07 21:22:45 +00001415/* The ORDER BY clause is ignored for all of the above */
danielk19776c8c8ce2008-01-02 16:27:09 +00001416#define IgnorableOrderby(X) ((X->eDest)<=SRT_Discard)
drh13449892005-09-07 21:22:45 +00001417
danielk19779ed1dfa2008-01-02 17:11:14 +00001418#define SRT_Callback 5 /* Invoke a callback with each row of result */
1419#define SRT_Mem 6 /* Store result in a memory cell */
1420#define SRT_Set 7 /* Store non-null results as keys in an index */
1421#define SRT_Table 8 /* Store result as data with an automatic rowid */
1422#define SRT_EphemTab 9 /* Create transient tab and store like SRT_Table */
1423#define SRT_Subroutine 10 /* Call a subroutine to handle results */
drh22827922000-06-06 17:27:05 +00001424
1425/*
danielk19776c8c8ce2008-01-02 16:27:09 +00001426** A structure used to customize the behaviour of sqlite3Select(). See
1427** comments above sqlite3Select() for details.
1428*/
1429typedef struct SelectDest SelectDest;
1430struct SelectDest {
drh477df4b2008-01-05 18:48:24 +00001431 u8 eDest; /* How to dispose of the results */
1432 u8 affinity; /* Affinity used when eDest==SRT_Set */
danielk19776c8c8ce2008-01-02 16:27:09 +00001433 int iParm; /* A parameter used by the eDest disposal method */
drh1013c932008-01-06 00:25:21 +00001434 int iMem; /* Base register where results are written */
drhad27e762008-03-26 12:46:23 +00001435 int nMem; /* Number of registers allocated */
danielk19776c8c8ce2008-01-02 16:27:09 +00001436};
1437
1438/*
drhf57b3392001-10-08 13:22:32 +00001439** An SQL parser context. A copy of this structure is passed through
1440** the parser and down into all the parser action routine in order to
1441** carry around information that is global to the entire parse.
drhf1974842004-11-05 03:56:00 +00001442**
1443** The structure is divided into two parts. When the parser and code
1444** generate call themselves recursively, the first part of the structure
1445** is constant but the second part is reset at the beginning and end of
1446** each recursion.
danielk1977c00da102006-01-07 13:21:04 +00001447**
1448** The nTableLock and aTableLock variables are only used if the shared-cache
1449** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
1450** used to store the set of table-locks required by the statement being
1451** compiled. Function sqlite3TableLock() is used to add entries to the
1452** list.
drh75897232000-05-29 14:26:00 +00001453*/
1454struct Parse {
drh9bb575f2004-09-06 17:24:11 +00001455 sqlite3 *db; /* The main database structure */
drh4c504392000-10-16 22:06:40 +00001456 int rc; /* Return code from execution */
drh75897232000-05-29 14:26:00 +00001457 char *zErrMsg; /* An error message */
drh75897232000-05-29 14:26:00 +00001458 Vdbe *pVdbe; /* An engine for executing database bytecode */
drh836faa42003-01-11 13:30:57 +00001459 u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */
drhe0bc4042002-06-25 01:09:11 +00001460 u8 nameClash; /* A permanent table name clashes with temp table name */
drha6ecd332004-06-10 00:29:09 +00001461 u8 checkSchema; /* Causes schema cookie check after an error */
drh205f48e2004-11-05 00:43:11 +00001462 u8 nested; /* Number of nested calls to the parser/code generator */
drh7e326c02007-05-15 16:51:37 +00001463 u8 parseError; /* True after a parsing error. Ticket #1794 */
drh892d3172008-01-10 03:46:36 +00001464 u8 nTempReg; /* Number of temporary registers in aTempReg[] */
drh2dcef112008-01-12 19:03:48 +00001465 u8 nTempInUse; /* Number of aTempReg[] currently checked out */
drh892d3172008-01-10 03:46:36 +00001466 int aTempReg[8]; /* Holding area for temporary registers */
1467 int nRangeReg; /* Size of the temporary register block */
1468 int iRangeReg; /* First register in temporary register block */
drh75897232000-05-29 14:26:00 +00001469 int nErr; /* Number of errors seen */
drh832508b2002-03-02 17:04:07 +00001470 int nTab; /* Number of previously allocated VDBE cursors */
drh19a775c2000-06-05 18:54:46 +00001471 int nMem; /* Number of memory cells used so far */
drhfef52082000-06-06 01:50:43 +00001472 int nSet; /* Number of sets used so far */
drhaa9b8962008-01-08 02:57:55 +00001473 int ckBase; /* Base register of data during check constraints */
drhe55cbd72008-03-31 23:48:03 +00001474 int disableColCache; /* True to disable adding to column cache */
1475 int nColCache; /* Number of entries in the column cache */
1476 int iColCache; /* Next entry of the cache to replace */
drh2f7794c2008-04-01 03:27:39 +00001477 struct yColCache {
drhe55cbd72008-03-31 23:48:03 +00001478 int iTable; /* Table cursor number */
1479 int iColumn; /* Table column number */
drhda250ea2008-04-01 05:07:14 +00001480 char affChange; /* True if this register has had an affinity change */
drhe55cbd72008-03-31 23:48:03 +00001481 int iReg; /* Register holding value of this column */
1482 } aColCache[10]; /* One for each valid column cache entry */
drh80242052004-06-09 00:48:12 +00001483 u32 writeMask; /* Start a write transaction on these databases */
drhfcd35c72005-05-21 02:48:08 +00001484 u32 cookieMask; /* Bitmask of schema verified databases */
1485 int cookieGoto; /* Address of OP_Goto to cookie verifier subroutine */
drhc797d4d2007-05-08 01:08:49 +00001486 int cookieValue[SQLITE_MAX_ATTACHED+2]; /* Values of cookies to verify */
danielk1977c00da102006-01-07 13:21:04 +00001487#ifndef SQLITE_OMIT_SHARED_CACHE
1488 int nTableLock; /* Number of locks in aTableLock */
1489 TableLock *aTableLock; /* Required table locks for shared-cache mode */
1490#endif
danielk1977cac336a2008-03-08 06:16:29 +00001491 int regRowid; /* Register holding rowid of CREATE TABLE entry */
1492 int regRoot; /* Register holding root page number for new objects */
drhf1974842004-11-05 03:56:00 +00001493
1494 /* Above is constant between recursions. Below is reset before and after
1495 ** each recursion */
1496
1497 int nVar; /* Number of '?' variables seen in the SQL so far */
1498 int nVarExpr; /* Number of used slots in apVarExpr[] */
1499 int nVarExprAlloc; /* Number of allocated slots in apVarExpr[] */
1500 Expr **apVarExpr; /* Pointers to :aaa and $aaaa wildcard expressions */
1501 u8 explain; /* True if the EXPLAIN flag is found on the query */
drhf1974842004-11-05 03:56:00 +00001502 Token sErrToken; /* The token at which the error occurred */
1503 Token sNameToken; /* Token with unqualified schema object name */
1504 Token sLastToken; /* The last token parsed */
1505 const char *zSql; /* All SQL text */
1506 const char *zTail; /* All SQL text past the last semicolon parsed */
1507 Table *pNewTable; /* A table being constructed by CREATE TABLE */
1508 Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */
1509 TriggerStack *trigStack; /* Trigger actions being coded */
1510 const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
drhb9bb7c12006-06-11 23:41:55 +00001511#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk197733b39332006-06-24 08:51:05 +00001512 Token sArg; /* Complete text of a module argument */
danielk1977f9e7dda2006-06-16 16:08:53 +00001513 u8 declareVtab; /* True if inside sqlite3_declare_vtab() */
1514 Table *pVirtualLock; /* Require virtual table lock on this table */
drhb9bb7c12006-06-11 23:41:55 +00001515#endif
danielk1977e6a58a42007-08-31 17:42:48 +00001516#if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
danielk1977fc976062007-05-10 10:46:56 +00001517 int nHeight; /* Expression tree height of current sub-select */
1518#endif
drh75897232000-05-29 14:26:00 +00001519};
1520
danielk19777e6ebfb2006-06-12 11:24:37 +00001521#ifdef SQLITE_OMIT_VIRTUALTABLE
1522 #define IN_DECLARE_VTAB 0
1523#else
1524 #define IN_DECLARE_VTAB (pParse->declareVtab)
1525#endif
1526
danielk1977d99bc932002-05-16 00:13:12 +00001527/*
drh85e20962003-04-25 17:52:11 +00001528** An instance of the following structure can be declared on a stack and used
1529** to save the Parse.zAuthContext value so that it can be restored later.
1530*/
1531struct AuthContext {
1532 const char *zAuthContext; /* Put saved Parse.zAuthContext here */
1533 Parse *pParse; /* The Parse structure */
1534};
1535
1536/*
drhf0863fe2005-06-12 21:35:51 +00001537** Bitfield flags for P2 value in OP_Insert and OP_Delete
rdcb0c374f2004-02-20 22:53:38 +00001538*/
1539#define OPFLAG_NCHANGE 1 /* Set to update db->nChange */
1540#define OPFLAG_LASTROWID 2 /* Set to update db->lastRowid */
danielk197794eb6a12005-12-15 15:22:08 +00001541#define OPFLAG_ISUPDATE 4 /* This OP_Insert is an sql UPDATE */
drhe4d90812007-03-29 05:51:49 +00001542#define OPFLAG_APPEND 8 /* This is likely to be an append */
rdcb0c374f2004-02-20 22:53:38 +00001543
1544/*
danielk1977d99bc932002-05-16 00:13:12 +00001545 * Each trigger present in the database schema is stored as an instance of
1546 * struct Trigger.
1547 *
1548 * Pointers to instances of struct Trigger are stored in two ways.
drh9bb575f2004-09-06 17:24:11 +00001549 * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
danielk1977d99bc932002-05-16 00:13:12 +00001550 * database). This allows Trigger structures to be retrieved by name.
1551 * 2. All triggers associated with a single table form a linked list, using the
drhad3cab52002-05-24 02:04:32 +00001552 * pNext member of struct Trigger. A pointer to the first element of the
1553 * linked list is stored as the "pTrigger" member of the associated
1554 * struct Table.
danielk1977d99bc932002-05-16 00:13:12 +00001555 *
drhad3cab52002-05-24 02:04:32 +00001556 * The "step_list" member points to the first element of a linked list
1557 * containing the SQL statements specified as the trigger program.
danielk1977d99bc932002-05-16 00:13:12 +00001558 */
danielk1977c3f9bad2002-05-15 08:30:12 +00001559struct Trigger {
drhdc379452002-05-15 12:45:43 +00001560 char *name; /* The name of the trigger */
1561 char *table; /* The table or view to which the trigger applies */
drhf0f258b2003-04-21 18:48:45 +00001562 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */
drhdca76842004-12-07 14:06:13 +00001563 u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
drhdc379452002-05-15 12:45:43 +00001564 Expr *pWhen; /* The WHEN clause of the expresion (may be NULL) */
1565 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger,
danielk1977d99bc932002-05-16 00:13:12 +00001566 the <column-list> is stored here */
drh4312db52003-06-03 01:47:11 +00001567 Token nameToken; /* Token containing zName. Use during parsing only */
danielk1977e501b892006-01-09 06:29:47 +00001568 Schema *pSchema; /* Schema containing the trigger */
1569 Schema *pTabSchema; /* Schema containing the table */
drhdc379452002-05-15 12:45:43 +00001570 TriggerStep *step_list; /* Link list of trigger program steps */
drhdc379452002-05-15 12:45:43 +00001571 Trigger *pNext; /* Next trigger associated with the table */
danielk1977c3f9bad2002-05-15 08:30:12 +00001572};
1573
danielk1977d99bc932002-05-16 00:13:12 +00001574/*
drhdca76842004-12-07 14:06:13 +00001575** A trigger is either a BEFORE or an AFTER trigger. The following constants
1576** determine which.
1577**
1578** If there are multiple triggers, you might of some BEFORE and some AFTER.
1579** In that cases, the constants below can be ORed together.
1580*/
1581#define TRIGGER_BEFORE 1
1582#define TRIGGER_AFTER 2
1583
1584/*
danielk1977d99bc932002-05-16 00:13:12 +00001585 * An instance of struct TriggerStep is used to store a single SQL statement
1586 * that is a part of a trigger-program.
1587 *
1588 * Instances of struct TriggerStep are stored in a singly linked list (linked
1589 * using the "pNext" member) referenced by the "step_list" member of the
1590 * associated struct Trigger instance. The first element of the linked list is
1591 * the first step of the trigger-program.
1592 *
1593 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
1594 * "SELECT" statement. The meanings of the other members is determined by the
1595 * value of "op" as follows:
1596 *
1597 * (op == TK_INSERT)
1598 * orconf -> stores the ON CONFLICT algorithm
1599 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then
1600 * this stores a pointer to the SELECT statement. Otherwise NULL.
1601 * target -> A token holding the name of the table to insert into.
1602 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
1603 * this stores values to be inserted. Otherwise NULL.
1604 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ...
drhad3cab52002-05-24 02:04:32 +00001605 * statement, then this stores the column-names to be
1606 * inserted into.
danielk1977d99bc932002-05-16 00:13:12 +00001607 *
1608 * (op == TK_DELETE)
1609 * target -> A token holding the name of the table to delete from.
1610 * pWhere -> The WHERE clause of the DELETE statement if one is specified.
1611 * Otherwise NULL.
1612 *
1613 * (op == TK_UPDATE)
1614 * target -> A token holding the name of the table to update rows of.
1615 * pWhere -> The WHERE clause of the UPDATE statement if one is specified.
1616 * Otherwise NULL.
1617 * pExprList -> A list of the columns to update and the expressions to update
danielk19774adee202004-05-08 08:23:19 +00001618 * them to. See sqlite3Update() documentation of "pChanges"
drhad3cab52002-05-24 02:04:32 +00001619 * argument.
danielk1977d99bc932002-05-16 00:13:12 +00001620 *
1621 */
1622struct TriggerStep {
1623 int op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1624 int orconf; /* OE_Rollback etc. */
drha69d9162003-04-17 22:57:53 +00001625 Trigger *pTrig; /* The trigger that this step is a part of */
danielk1977c3f9bad2002-05-15 08:30:12 +00001626
danielk1977d99bc932002-05-16 00:13:12 +00001627 Select *pSelect; /* Valid for SELECT and sometimes
drhfd131da2007-08-07 17:13:03 +00001628 INSERT steps (when pExprList == 0) */
danielk1977d99bc932002-05-16 00:13:12 +00001629 Token target; /* Valid for DELETE, UPDATE, INSERT steps */
1630 Expr *pWhere; /* Valid for DELETE, UPDATE steps */
1631 ExprList *pExprList; /* Valid for UPDATE statements and sometimes
drhfd131da2007-08-07 17:13:03 +00001632 INSERT steps (when pSelect == 0) */
danielk1977d99bc932002-05-16 00:13:12 +00001633 IdList *pIdList; /* Valid for INSERT statements only */
drh187e4c62006-02-27 22:22:27 +00001634 TriggerStep *pNext; /* Next in the link-list */
1635 TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */
danielk1977d99bc932002-05-16 00:13:12 +00001636};
1637
1638/*
1639 * An instance of struct TriggerStack stores information required during code
1640 * generation of a single trigger program. While the trigger program is being
1641 * coded, its associated TriggerStack instance is pointed to by the
1642 * "pTriggerStack" member of the Parse structure.
1643 *
1644 * The pTab member points to the table that triggers are being coded on. The
1645 * newIdx member contains the index of the vdbe cursor that points at the temp
1646 * table that stores the new.* references. If new.* references are not valid
1647 * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1648 * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1649 *
1650 * The ON CONFLICT policy to be used for the trigger program steps is stored
1651 * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1652 * specified for individual triggers steps is used.
1653 *
1654 * struct TriggerStack has a "pNext" member, to allow linked lists to be
1655 * constructed. When coding nested triggers (triggers fired by other triggers)
1656 * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1657 * pointer. Once the nested trigger has been coded, the pNext value is restored
1658 * to the pTriggerStack member of the Parse stucture and coding of the parent
1659 * trigger continues.
1660 *
1661 * Before a nested trigger is coded, the linked list pointed to by the
1662 * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1663 * recursively. If this condition is detected, the nested trigger is not coded.
1664 */
1665struct TriggerStack {
1666 Table *pTab; /* Table that triggers are currently being coded on */
1667 int newIdx; /* Index of vdbe cursor to "new" temp table */
1668 int oldIdx; /* Index of vdbe cursor to "old" temp table */
danielk19778f2c54e2008-01-01 19:02:09 +00001669 u32 newColMask;
1670 u32 oldColMask;
danielk1977d99bc932002-05-16 00:13:12 +00001671 int orconf; /* Current orconf policy */
danielk19776f349032002-06-11 02:25:40 +00001672 int ignoreJump; /* where to jump to for a RAISE(IGNORE) */
drhe22a3342003-04-22 20:30:37 +00001673 Trigger *pTrigger; /* The trigger currently being coded */
1674 TriggerStack *pNext; /* Next trigger down on the trigger stack */
danielk1977d99bc932002-05-16 00:13:12 +00001675};
1676
1677/*
drhf26e09c2003-05-31 16:21:12 +00001678** The following structure contains information used by the sqliteFix...
1679** routines as they walk the parse tree to make database references
1680** explicit.
1681*/
1682typedef struct DbFixer DbFixer;
1683struct DbFixer {
1684 Parse *pParse; /* The parsing context. Error messages written here */
1685 const char *zDb; /* Make sure all objects are contained in this database */
1686 const char *zType; /* Type of the container - used for error messages */
1687 const Token *pName; /* Name of the container - used for error messages */
1688};
1689
1690/*
drhade86482007-11-28 22:36:40 +00001691** An objected used to accumulate the text of a string where we
1692** do not necessarily know how big the string will be in the end.
1693*/
1694struct StrAccum {
1695 char *zBase; /* A base allocation. Not from malloc. */
1696 char *zText; /* The string collected so far */
1697 int nChar; /* Length of the string so far */
1698 int nAlloc; /* Amount of space allocated in zText */
drhbb4957f2008-03-20 14:03:29 +00001699 int mxAlloc; /* Maximum allowed string length */
drhade86482007-11-28 22:36:40 +00001700 u8 mallocFailed; /* Becomes true if any memory allocation fails */
1701 u8 useMalloc; /* True if zText is enlargable using realloc */
1702 u8 tooBig; /* Becomes true if string size exceeds limits */
1703};
1704
1705/*
drh234c39d2004-07-24 03:30:47 +00001706** A pointer to this structure is used to communicate information
1707** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
1708*/
1709typedef struct {
drh9bb575f2004-09-06 17:24:11 +00001710 sqlite3 *db; /* The database being initialized */
drhece3c722006-09-23 20:36:01 +00001711 int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */
drh234c39d2004-07-24 03:30:47 +00001712 char **pzErrMsg; /* Error message stored here */
drh15ca1df2006-07-26 13:43:30 +00001713 int rc; /* Result code stored here */
drh234c39d2004-07-24 03:30:47 +00001714} InitData;
1715
drhb6c29892004-11-22 19:12:19 +00001716/*
drh66150952007-07-23 19:12:41 +00001717** Assuming zIn points to the first byte of a UTF-8 character,
1718** advance zIn to point to the first byte of the next UTF-8 character.
drh4a919112007-05-15 11:55:09 +00001719*/
drh4a919112007-05-15 11:55:09 +00001720#define SQLITE_SKIP_UTF8(zIn) { \
1721 if( (*(zIn++))>=0xc0 ){ \
1722 while( (*zIn & 0xc0)==0x80 ){ zIn++; } \
1723 } \
1724}
1725
drh4a919112007-05-15 11:55:09 +00001726/*
drh49285702005-09-17 15:20:26 +00001727** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production
1728** builds) or a function call (for debugging). If it is a function call,
1729** it allows the operator to set a breakpoint at the spot where database
1730** corruption is first detected.
1731*/
1732#ifdef SQLITE_DEBUG
drh6e736832007-05-11 12:30:03 +00001733 int sqlite3Corrupt(void);
drh49285702005-09-17 15:20:26 +00001734# define SQLITE_CORRUPT_BKPT sqlite3Corrupt()
drhe5fe6902007-12-07 18:55:28 +00001735# define DEBUGONLY(X) X
drh49285702005-09-17 15:20:26 +00001736#else
1737# define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT
drhe5fe6902007-12-07 18:55:28 +00001738# define DEBUGONLY(X)
drh49285702005-09-17 15:20:26 +00001739#endif
1740
1741/*
drh75897232000-05-29 14:26:00 +00001742** Internal function prototypes
1743*/
danielk19774adee202004-05-08 08:23:19 +00001744int sqlite3StrICmp(const char *, const char *);
1745int sqlite3StrNICmp(const char *, const char *, int);
danielk19778a6b5412004-05-24 07:04:25 +00001746int sqlite3IsNumber(const char*, int*, u8);
danielk19772e588c72005-12-09 14:25:08 +00001747
drh17435752007-08-16 04:30:38 +00001748void *sqlite3MallocZero(unsigned);
1749void *sqlite3DbMallocZero(sqlite3*, unsigned);
1750void *sqlite3DbMallocRaw(sqlite3*, unsigned);
danielk19772e588c72005-12-09 14:25:08 +00001751char *sqlite3StrDup(const char*);
1752char *sqlite3StrNDup(const char*, int);
drh17435752007-08-16 04:30:38 +00001753char *sqlite3DbStrDup(sqlite3*,const char*);
1754char *sqlite3DbStrNDup(sqlite3*,const char*, int);
drh97c8ec32007-08-27 21:49:34 +00001755void *sqlite3DbReallocOrFree(sqlite3 *, void *, int);
danielk1977a1644fd2007-08-29 12:31:25 +00001756void *sqlite3DbRealloc(sqlite3 *, void *, int);
danielk1977a7a8e142008-02-13 18:25:27 +00001757int sqlite3MallocSize(void *);
danielk19772e588c72005-12-09 14:25:08 +00001758
drh17435752007-08-16 04:30:38 +00001759char *sqlite3MPrintf(sqlite3*,const char*, ...);
1760char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
drh87cc3b32007-05-08 21:45:27 +00001761#if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
1762 void sqlite3DebugPrintf(const char*, ...);
drhd919fe12007-12-11 19:34:44 +00001763#endif
1764#if defined(SQLITE_TEST)
drh87cc3b32007-05-08 21:45:27 +00001765 void *sqlite3TextToPtr(const char*);
1766#endif
drh41f58522005-06-06 15:06:39 +00001767void sqlite3SetString(char **, ...);
danielk19774adee202004-05-08 08:23:19 +00001768void sqlite3ErrorMsg(Parse*, const char*, ...);
drha0733842005-12-29 01:11:36 +00001769void sqlite3ErrorClear(Parse*);
danielk19774adee202004-05-08 08:23:19 +00001770void sqlite3Dequote(char*);
drh17435752007-08-16 04:30:38 +00001771void sqlite3DequoteExpr(sqlite3*, Expr*);
drh2646da72005-12-09 20:02:05 +00001772int sqlite3KeywordCode(const unsigned char*, int);
danielk19774adee202004-05-08 08:23:19 +00001773int sqlite3RunParser(Parse*, const char*, char **);
drh80242052004-06-09 00:48:12 +00001774void sqlite3FinishCoding(Parse*);
drh892d3172008-01-10 03:46:36 +00001775int sqlite3GetTempReg(Parse*);
1776void sqlite3ReleaseTempReg(Parse*,int);
1777int sqlite3GetTempRange(Parse*,int);
1778void sqlite3ReleaseTempRange(Parse*,int,int);
danielk1977a1644fd2007-08-29 12:31:25 +00001779Expr *sqlite3Expr(sqlite3*, int, Expr*, Expr*, const Token*);
drh17435752007-08-16 04:30:38 +00001780Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*);
drh4e0cff62004-11-05 05:10:28 +00001781Expr *sqlite3RegisterExpr(Parse*,Token*);
danielk19771e536952007-08-16 10:09:01 +00001782Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
danielk19774adee202004-05-08 08:23:19 +00001783void sqlite3ExprSpan(Expr*,Token*,Token*);
drh17435752007-08-16 04:30:38 +00001784Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
drhfa6bc002004-09-07 16:19:52 +00001785void sqlite3ExprAssignVarNumber(Parse*, Expr*);
danielk19774adee202004-05-08 08:23:19 +00001786void sqlite3ExprDelete(Expr*);
drh17435752007-08-16 04:30:38 +00001787ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*,Token*);
danielk19774adee202004-05-08 08:23:19 +00001788void sqlite3ExprListDelete(ExprList*);
drh9bb575f2004-09-06 17:24:11 +00001789int sqlite3Init(sqlite3*, char**);
drh234c39d2004-07-24 03:30:47 +00001790int sqlite3InitCallback(void*, int, char**, char**);
danielk197791cf71b2004-06-26 06:37:06 +00001791void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
drh9bb575f2004-09-06 17:24:11 +00001792void sqlite3ResetInternalSchema(sqlite3*, int);
danielk19774adee202004-05-08 08:23:19 +00001793void sqlite3BeginParse(Parse*,int);
drh9bb575f2004-09-06 17:24:11 +00001794void sqlite3CommitInternalChanges(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00001795Table *sqlite3ResultSetOfSelect(Parse*,char*,Select*);
danielk1977c00da102006-01-07 13:21:04 +00001796void sqlite3OpenMasterTable(Parse *, int);
danielk1977f1a381e2006-06-16 08:01:02 +00001797void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
danielk19774adee202004-05-08 08:23:19 +00001798void sqlite3AddColumn(Parse*,Token*);
1799void sqlite3AddNotNull(Parse*, int);
drhfdd6e852005-12-16 01:06:16 +00001800void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
drhffe07b22005-11-03 00:41:17 +00001801void sqlite3AddCheckConstraint(Parse*, Expr*);
drh487e2622005-06-25 18:42:14 +00001802void sqlite3AddColumnType(Parse*,Token*);
danielk19777977a172004-11-09 12:44:37 +00001803void sqlite3AddDefaultValue(Parse*,Expr*);
danielk197739002502007-11-12 09:50:26 +00001804void sqlite3AddCollateType(Parse*, Token*);
danielk197719a8e7e2005-03-17 05:03:38 +00001805void sqlite3EndTable(Parse*,Token*,Token*,Select*);
drhb7f91642004-10-31 02:22:47 +00001806
drhf5e7bb52008-02-18 14:47:33 +00001807Bitvec *sqlite3BitvecCreate(u32);
1808int sqlite3BitvecTest(Bitvec*, u32);
1809int sqlite3BitvecSet(Bitvec*, u32);
1810void sqlite3BitvecClear(Bitvec*, u32);
1811void sqlite3BitvecDestroy(Bitvec*);
drh3088d592008-03-21 16:45:47 +00001812int sqlite3BitvecBuiltinTest(int,int*);
drhf5e7bb52008-02-18 14:47:33 +00001813
drhfdd48a72006-09-11 23:45:48 +00001814void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int);
danielk1977fe3fcbe22006-06-12 12:08:45 +00001815
1816#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
drhb7f91642004-10-31 02:22:47 +00001817 int sqlite3ViewGetColumnNames(Parse*,Table*);
1818#else
1819# define sqlite3ViewGetColumnNames(A,B) 0
1820#endif
1821
drha0733842005-12-29 01:11:36 +00001822void sqlite3DropTable(Parse*, SrcList*, int, int);
danielk1977a04a34f2007-04-16 15:06:25 +00001823void sqlite3DeleteTable(Table*);
danielk19774adee202004-05-08 08:23:19 +00001824void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
drh17435752007-08-16 04:30:38 +00001825void *sqlite3ArrayAllocate(sqlite3*,void*,int,int,int*,int*,int*);
1826IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
danielk19774adee202004-05-08 08:23:19 +00001827int sqlite3IdListIndex(IdList*,const char*);
drh17435752007-08-16 04:30:38 +00001828SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
1829SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*, Token*,
drh61dfc312006-12-16 16:25:15 +00001830 Select*, Expr*, IdList*);
1831void sqlite3SrcListShiftJoinType(SrcList*);
danielk19774adee202004-05-08 08:23:19 +00001832void sqlite3SrcListAssignCursors(Parse*, SrcList*);
1833void sqlite3IdListDelete(IdList*);
1834void sqlite3SrcListDelete(SrcList*);
danielk19770202b292004-06-09 09:55:16 +00001835void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
drh4d91a702006-01-04 15:54:36 +00001836 Token*, int, int);
1837void sqlite3DropIndex(Parse*, SrcList*, int);
danielk19776c8c8ce2008-01-02 16:27:09 +00001838int sqlite3Select(Parse*, Select*, SelectDest*, Select*, int, int*, char *aff);
drh17435752007-08-16 04:30:38 +00001839Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
1840 Expr*,ExprList*,int,Expr*,Expr*);
danielk19774adee202004-05-08 08:23:19 +00001841void sqlite3SelectDelete(Select*);
danielk19774adee202004-05-08 08:23:19 +00001842Table *sqlite3SrcListLookup(Parse*, SrcList*);
1843int sqlite3IsReadOnly(Parse*, Table*, int);
danielk1977c00da102006-01-07 13:21:04 +00001844void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
danielk19774adee202004-05-08 08:23:19 +00001845void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
1846void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
danielk1977a9d1ccb2008-01-05 17:39:29 +00001847WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**, u8);
danielk19774adee202004-05-08 08:23:19 +00001848void sqlite3WhereEnd(WhereInfo*);
drhda250ea2008-04-01 05:07:14 +00001849int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, int);
drhe55cbd72008-03-31 23:48:03 +00001850void sqlite3ExprCodeMove(Parse*, int, int);
1851void sqlite3ExprClearColumnCache(Parse*, int);
drhda250ea2008-04-01 05:07:14 +00001852void sqlite3ExprCacheAffinityChange(Parse*, int, int);
drh652fbf52008-04-01 01:42:41 +00001853int sqlite3ExprWritableRegister(Parse*,int,int);
drh191b54c2008-04-15 12:14:21 +00001854void sqlite3ExprHardCopy(Parse*,int,int);
drh389a1ad2008-01-03 23:44:53 +00001855int sqlite3ExprCode(Parse*, Expr*, int);
drh2dcef112008-01-12 19:03:48 +00001856int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
drh678ccce2008-03-31 18:19:54 +00001857int sqlite3ExprCodeTarget(Parse*, Expr*, int);
drh2dcef112008-01-12 19:03:48 +00001858int sqlite3ExprCodeAndCache(Parse*, Expr*, int);
drh678ccce2008-03-31 18:19:54 +00001859void sqlite3ExprCodeConstants(Parse*, Expr*);
drh191b54c2008-04-15 12:14:21 +00001860int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int);
danielk19774adee202004-05-08 08:23:19 +00001861void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
1862void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
drh9bb575f2004-09-06 17:24:11 +00001863Table *sqlite3FindTable(sqlite3*,const char*, const char*);
drhca424112008-01-25 15:04:48 +00001864Table *sqlite3LocateTable(Parse*,int isView,const char*, const char*);
drh9bb575f2004-09-06 17:24:11 +00001865Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
1866void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
1867void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
drh74161702006-02-24 02:53:49 +00001868void sqlite3Vacuum(Parse*);
drh9bb575f2004-09-06 17:24:11 +00001869int sqlite3RunVacuum(char**, sqlite3*);
drh17435752007-08-16 04:30:38 +00001870char *sqlite3NameFromToken(sqlite3*, Token*);
danielk19774adee202004-05-08 08:23:19 +00001871int sqlite3ExprCompare(Expr*, Expr*);
danielk1977b3bce662005-01-29 08:32:43 +00001872int sqlite3ExprResolveNames(NameContext *, Expr *);
drhd2b3e232008-01-23 14:51:49 +00001873void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
1874void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
danielk19774adee202004-05-08 08:23:19 +00001875Vdbe *sqlite3GetVdbe(Parse*);
danielk19771e536952007-08-16 10:09:01 +00001876Expr *sqlite3CreateIdExpr(Parse *, const char*);
drh2fa18682008-03-19 14:15:34 +00001877void sqlite3PrngSaveState(void);
1878void sqlite3PrngRestoreState(void);
1879void sqlite3PrngResetState(void);
drh9bb575f2004-09-06 17:24:11 +00001880void sqlite3RollbackAll(sqlite3*);
danielk19774adee202004-05-08 08:23:19 +00001881void sqlite3CodeVerifySchema(Parse*, int);
drh684917c2004-10-05 02:41:42 +00001882void sqlite3BeginTransaction(Parse*, int);
danielk19774adee202004-05-08 08:23:19 +00001883void sqlite3CommitTransaction(Parse*);
1884void sqlite3RollbackTransaction(Parse*);
1885int sqlite3ExprIsConstant(Expr*);
drh0a168372007-06-08 00:20:47 +00001886int sqlite3ExprIsConstantNotJoin(Expr*);
drheb55bd22005-06-30 17:04:21 +00001887int sqlite3ExprIsConstantOrFunction(Expr*);
danielk19774adee202004-05-08 08:23:19 +00001888int sqlite3ExprIsInteger(Expr*, int*);
1889int sqlite3IsRowid(const char*);
drh2d401ab2008-01-10 23:50:11 +00001890void sqlite3GenerateRowDelete(Parse*, Table*, int, int, int);
1891void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int*);
drhe14006d2008-03-25 17:23:32 +00001892int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int);
drh04adf412008-01-08 18:57:50 +00001893void sqlite3GenerateConstraintChecks(Parse*,Table*,int,int,
1894 int*,int,int,int,int);
1895void sqlite3CompleteInsertion(Parse*, Table*, int, int, int*,int,int,int,int);
drhaa9b8962008-01-08 02:57:55 +00001896int sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
danielk19774adee202004-05-08 08:23:19 +00001897void sqlite3BeginWriteOperation(Parse*, int, int);
drh17435752007-08-16 04:30:38 +00001898Expr *sqlite3ExprDup(sqlite3*,Expr*);
1899void sqlite3TokenCopy(sqlite3*,Token*, Token*);
1900ExprList *sqlite3ExprListDup(sqlite3*,ExprList*);
1901SrcList *sqlite3SrcListDup(sqlite3*,SrcList*);
1902IdList *sqlite3IdListDup(sqlite3*,IdList*);
1903Select *sqlite3SelectDup(sqlite3*,Select*);
drh9bb575f2004-09-06 17:24:11 +00001904FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
1905void sqlite3RegisterBuiltinFunctions(sqlite3*);
1906void sqlite3RegisterDateTimeFunctions(sqlite3*);
drh7e8b8482008-01-23 03:03:05 +00001907#ifdef SQLITE_DEBUG
1908 int sqlite3SafetyOn(sqlite3*);
1909 int sqlite3SafetyOff(sqlite3*);
1910#else
1911# define sqlite3SafetyOn(A) 0
1912# define sqlite3SafetyOff(A) 0
1913#endif
1914int sqlite3SafetyCheckOk(sqlite3*);
1915int sqlite3SafetyCheckSickOrOk(sqlite3*);
drh9cbf3422008-01-17 16:22:13 +00001916void sqlite3ChangeCookie(Parse*, int);
drhf93d9992008-04-15 14:36:42 +00001917void sqlite3MaterializeView(Parse*, Select*, Expr*, int);
drhb7f91642004-10-31 02:22:47 +00001918
1919#ifndef SQLITE_OMIT_TRIGGER
1920 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
drh60218d22007-04-06 11:26:00 +00001921 Expr*,int, int);
drhb7f91642004-10-31 02:22:47 +00001922 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
drhfdd48a72006-09-11 23:45:48 +00001923 void sqlite3DropTrigger(Parse*, SrcList*, int);
drh74161702006-02-24 02:53:49 +00001924 void sqlite3DropTriggerPtr(Parse*, Trigger*);
drhdca76842004-12-07 14:06:13 +00001925 int sqlite3TriggersExist(Parse*, Table*, int, ExprList*);
drhb7f91642004-10-31 02:22:47 +00001926 int sqlite3CodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
danielk19778f2c54e2008-01-01 19:02:09 +00001927 int, int, u32*, u32*);
drhb7f91642004-10-31 02:22:47 +00001928 void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
1929 void sqlite3DeleteTriggerStep(TriggerStep*);
drh17435752007-08-16 04:30:38 +00001930 TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*);
1931 TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
1932 ExprList*,Select*,int);
1933 TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, int);
1934 TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*);
drhb7f91642004-10-31 02:22:47 +00001935 void sqlite3DeleteTrigger(Trigger*);
1936 void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
1937#else
1938# define sqlite3TriggersExist(A,B,C,D,E,F) 0
1939# define sqlite3DeleteTrigger(A)
drhcdd536f2006-03-17 00:04:03 +00001940# define sqlite3DropTriggerPtr(A,B)
drhb7f91642004-10-31 02:22:47 +00001941# define sqlite3UnlinkAndDeleteTrigger(A,B,C)
danielk19778f2c54e2008-01-01 19:02:09 +00001942# define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I,J,K) 0
drhb7f91642004-10-31 02:22:47 +00001943#endif
1944
danielk19774adee202004-05-08 08:23:19 +00001945int sqlite3JoinType(Parse*, Token*, Token*, Token*);
danielk19770202b292004-06-09 09:55:16 +00001946void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
danielk19774adee202004-05-08 08:23:19 +00001947void sqlite3DeferForeignKey(Parse*, int);
drhed6c8672003-01-12 18:02:16 +00001948#ifndef SQLITE_OMIT_AUTHORIZATION
drh728b5772007-09-18 15:55:07 +00001949 void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
danielk19774adee202004-05-08 08:23:19 +00001950 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
1951 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
1952 void sqlite3AuthContextPop(AuthContext*);
drhed6c8672003-01-12 18:02:16 +00001953#else
danielk1977b5258c32007-10-04 18:11:15 +00001954# define sqlite3AuthRead(a,b,c,d)
danielk19774adee202004-05-08 08:23:19 +00001955# define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK
1956# define sqlite3AuthContextPush(a,b,c)
1957# define sqlite3AuthContextPop(a) ((void)(a))
drhed6c8672003-01-12 18:02:16 +00001958#endif
danielk1977f744bb52005-12-06 17:19:11 +00001959void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
1960void sqlite3Detach(Parse*, Expr*);
drh9bb575f2004-09-06 17:24:11 +00001961int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
drh33f4e022007-09-03 15:19:34 +00001962 int omitJournal, int nCache, int flags, Btree **ppBtree);
danielk19774adee202004-05-08 08:23:19 +00001963int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
1964int sqlite3FixSrcList(DbFixer*, SrcList*);
1965int sqlite3FixSelect(DbFixer*, Select*);
1966int sqlite3FixExpr(DbFixer*, Expr*);
1967int sqlite3FixExprList(DbFixer*, ExprList*);
1968int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
drh487e2622005-06-25 18:42:14 +00001969int sqlite3AtoF(const char *z, double*);
danielk19776f8a5032004-05-10 10:34:51 +00001970char *sqlite3_snprintf(int,char*,const char*,...);
drhfec19aa2004-05-19 20:41:03 +00001971int sqlite3GetInt32(const char *, int*);
drh598f1342007-10-23 15:39:45 +00001972int sqlite3FitsIn64Bits(const char *, int);
drhee858132007-05-08 20:37:38 +00001973int sqlite3Utf16ByteLen(const void *pData, int nChar);
1974int sqlite3Utf8CharLen(const char *pData, int nByte);
drh66150952007-07-23 19:12:41 +00001975int sqlite3Utf8Read(const u8*, const u8*, const u8**);
shane3f8d5cf2008-04-24 19:15:09 +00001976
1977/*
1978** Routines to read and write variable-length integers. These used to
1979** be defined locally, but now we use the varint routines in the util.c
1980** file.
1981*/
drh35b5a332008-04-05 18:41:42 +00001982int sqlite3PutVarint(unsigned char*, u64);
1983int sqlite3PutVarint32(unsigned char*, u32);
danielk197790e4d952004-05-10 10:05:53 +00001984int sqlite3GetVarint(const unsigned char *, u64 *);
drh6d2fb152004-05-14 16:50:06 +00001985int sqlite3GetVarint32(const unsigned char *, u32 *);
danielk1977192ac1d2004-05-10 07:17:30 +00001986int sqlite3VarintLen(u64 v);
shane3f8d5cf2008-04-24 19:15:09 +00001987
1988/*
1989** The header of a record consists of a sequence variable-length integers.
1990** These integers are almost always small and are encoded as a single byte.
1991** The following macros take advantage this fact to provide a fast encode
1992** and decode of the integers in a record header. It is faster for the common
1993** case where the integer is a single byte. It is a little slower when the
1994** integer is two or more bytes. But overall it is faster.
1995**
1996** The following expressions are equivalent:
1997**
1998** x = sqlite3GetVarint32( A, &B );
1999** x = sqlite3PutVarint32( A, B );
2000**
2001** x = getVarint32( A, B );
2002** x = putVarint32( A, B );
2003**
2004*/
2005#define getVarint32(A,B) ((*(A)<(unsigned char)0x80) ? ((B) = (u32)*(A)),1 : sqlite3GetVarint32((A), &(B)))
2006#define putVarint32(A,B) (((B)<(u32)0x80) ? (*(A) = (unsigned char)(B)),1 : sqlite3PutVarint32((A), (B)))
2007#define getVarint sqlite3GetVarint
2008#define putVarint sqlite3PutVarint
2009
2010
danielk1977a37cdde2004-05-16 11:15:36 +00002011void sqlite3IndexAffinityStr(Vdbe *, Index *);
2012void sqlite3TableAffinityStr(Vdbe *, Table *);
danielk1977e014a832004-05-17 10:48:57 +00002013char sqlite3CompareAffinity(Expr *pExpr, char aff2);
danielk1977e014a832004-05-17 10:48:57 +00002014int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
danielk1977bf3b7212004-05-18 10:06:24 +00002015char sqlite3ExprAffinity(Expr *pExpr);
drhb6a9ece2007-06-26 00:37:27 +00002016int sqlite3Atoi64(const char*, i64*);
drh9bb575f2004-09-06 17:24:11 +00002017void sqlite3Error(sqlite3*, int, const char*,...);
drhca48c902008-01-18 14:08:24 +00002018void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
danielk1977ef2cb632004-05-29 02:37:19 +00002019int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
danielk1977f20b21c2004-05-31 23:56:42 +00002020const char *sqlite3ErrStr(int);
danielk19778a414492004-06-29 08:59:35 +00002021int sqlite3ReadSchema(Parse *pParse);
drh9bb575f2004-09-06 17:24:11 +00002022CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
danielk19770202b292004-06-09 09:55:16 +00002023CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
danielk19777cedc8d2004-06-10 10:50:08 +00002024CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
drh8b4c40d2007-02-01 23:02:45 +00002025Expr *sqlite3ExprSetColl(Parse *pParse, Expr *, Token *);
danielk19777cedc8d2004-06-10 10:50:08 +00002026int sqlite3CheckCollSeq(Parse *, CollSeq *);
danielk1977d8123362004-06-12 09:25:12 +00002027int sqlite3CheckObjectName(Parse *, const char *);
danielk1977b28af712004-06-21 06:50:26 +00002028void sqlite3VdbeSetChanges(sqlite3 *, int);
danielk19774e6af132004-06-10 14:01:08 +00002029
drhb21c8cd2007-08-21 19:33:56 +00002030const void *sqlite3ValueText(sqlite3_value*, u8);
2031int sqlite3ValueBytes(sqlite3_value*, u8);
2032void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
danielk19771e536952007-08-16 10:09:01 +00002033 void(*)(void*));
danielk19774e6af132004-06-10 14:01:08 +00002034void sqlite3ValueFree(sqlite3_value*);
danielk19771e536952007-08-16 10:09:01 +00002035sqlite3_value *sqlite3ValueNew(sqlite3 *);
2036char *sqlite3Utf16to8(sqlite3 *, const void*, int);
2037int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
drhb21c8cd2007-08-21 19:33:56 +00002038void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
drh46c99e02007-08-27 23:26:59 +00002039#ifndef SQLITE_AMALGAMATION
drh4e5ffc52004-08-31 00:52:37 +00002040extern const unsigned char sqlite3UpperToLower[];
drh46c99e02007-08-27 23:26:59 +00002041#endif
danielk1977a0bf2652004-11-04 14:30:04 +00002042void sqlite3RootPageMoved(Db*, int, int);
drh4343fea2004-11-05 23:46:15 +00002043void sqlite3Reindex(Parse*, Token*, Token*);
drh1f01ec12005-02-15 21:36:18 +00002044void sqlite3AlterFunctions(sqlite3*);
danielk19779fd2a9a2004-11-12 13:42:30 +00002045void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
2046int sqlite3GetToken(const unsigned char *, int *);
drh2958a4e2004-11-12 03:56:15 +00002047void sqlite3NestedParse(Parse*, const char*, ...);
drhd89bd002005-01-22 03:03:54 +00002048void sqlite3ExpirePreparedStatements(sqlite3*);
danielk1977b3bce662005-01-29 08:32:43 +00002049void sqlite3CodeSubselect(Parse *, Expr *);
2050int sqlite3SelectResolve(Parse *, Select *, NameContext *);
danielk1977aee18ef2005-03-09 12:26:50 +00002051void sqlite3ColumnDefault(Vdbe *, Table *, int);
danielk197719a8e7e2005-03-17 05:03:38 +00002052void sqlite3AlterFinishAddColumn(Parse *, Token *);
2053void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
danielk19774dade032005-05-25 10:45:10 +00002054CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int);
drh8a512562005-11-14 22:29:05 +00002055char sqlite3AffinityType(const Token*);
drh9f18e8a2005-07-08 12:13:04 +00002056void sqlite3Analyze(Parse*, Token*, Token*);
drha4afb652005-07-09 02:16:02 +00002057int sqlite3InvokeBusyHandler(BusyHandler*);
drhff2d5ea2005-07-23 00:41:48 +00002058int sqlite3FindDb(sqlite3*, Token*);
drhcf1be452007-05-12 12:08:51 +00002059int sqlite3AnalysisLoad(sqlite3*,int iDB);
drh51147ba2005-07-23 22:59:55 +00002060void sqlite3DefaultRowEst(Index*);
drh55ef4d92005-08-14 01:20:37 +00002061void sqlite3RegisterLikeFunctions(sqlite3*, int);
drhd64fe2f2005-08-28 17:00:23 +00002062int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
danielk1977f744bb52005-12-06 17:19:11 +00002063void sqlite3AttachFunctions(sqlite3 *);
drhfdd6e852005-12-16 01:06:16 +00002064void sqlite3MinimumFileFormat(Parse*, int, int);
danielk1977da184232006-01-05 11:34:32 +00002065void sqlite3SchemaFree(void *);
danielk19771e536952007-08-16 10:09:01 +00002066Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
danielk1977e501b892006-01-09 06:29:47 +00002067int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
danielk1977b3bf5562006-01-10 17:58:23 +00002068KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *);
danielk1977771151b2006-01-17 13:21:40 +00002069int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
2070 void (*)(sqlite3_context*,int,sqlite3_value **),
2071 void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*));
danielk197754f01982006-01-18 15:25:17 +00002072int sqlite3ApiExit(sqlite3 *db, int);
danielk1977ddfb2f02006-02-17 12:25:14 +00002073int sqlite3OpenTempDatabase(Parse *);
drh69dab1d2006-06-27 14:37:20 +00002074
drhade86482007-11-28 22:36:40 +00002075void sqlite3StrAccumAppend(StrAccum*,const char*,int);
2076char *sqlite3StrAccumFinish(StrAccum*);
2077void sqlite3StrAccumReset(StrAccum*);
drh1013c932008-01-06 00:25:21 +00002078void sqlite3SelectDestInit(SelectDest*,int,int);
danielk19771e536952007-08-16 10:09:01 +00002079
drh95bdbbb2007-07-23 19:31:16 +00002080/*
2081** The interface to the LEMON-generated parser
2082*/
2083void *sqlite3ParserAlloc(void*(*)(size_t));
2084void sqlite3ParserFree(void*, void(*)(void*));
2085void sqlite3Parser(void*, int, Token, Parse*);
2086
drhcaa639f2008-03-20 00:32:20 +00002087int sqlite3AutoLoadExtensions(sqlite3*);
drh69dab1d2006-06-27 14:37:20 +00002088#ifndef SQLITE_OMIT_LOAD_EXTENSION
2089 void sqlite3CloseExtensions(sqlite3*);
2090#else
2091# define sqlite3CloseExtensions(X)
2092#endif
danielk1977e3026632004-06-22 11:29:02 +00002093
danielk1977c00da102006-01-07 13:21:04 +00002094#ifndef SQLITE_OMIT_SHARED_CACHE
2095 void sqlite3TableLock(Parse *, int, int, u8, const char *);
2096#else
2097 #define sqlite3TableLock(v,w,x,y,z)
2098#endif
2099
drh53c14022007-05-10 17:23:11 +00002100#ifdef SQLITE_TEST
2101 int sqlite3Utf8To8(unsigned char*);
2102#endif
2103
drhb9bb7c12006-06-11 23:41:55 +00002104#ifdef SQLITE_OMIT_VIRTUALTABLE
2105# define sqlite3VtabClear(X)
danielk1977f9e7dda2006-06-16 16:08:53 +00002106# define sqlite3VtabSync(X,Y) (Y)
2107# define sqlite3VtabRollback(X)
2108# define sqlite3VtabCommit(X)
drhb9bb7c12006-06-11 23:41:55 +00002109#else
drh707205d2006-06-17 10:44:42 +00002110 void sqlite3VtabClear(Table*);
danielk1977f9e7dda2006-06-16 16:08:53 +00002111 int sqlite3VtabSync(sqlite3 *db, int rc);
2112 int sqlite3VtabRollback(sqlite3 *db);
2113 int sqlite3VtabCommit(sqlite3 *db);
drhb9bb7c12006-06-11 23:41:55 +00002114#endif
drh189d4af2006-09-02 20:57:52 +00002115void sqlite3VtabLock(sqlite3_vtab*);
danielk1977a04a34f2007-04-16 15:06:25 +00002116void sqlite3VtabUnlock(sqlite3*, sqlite3_vtab*);
drhb9bb7c12006-06-11 23:41:55 +00002117void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*);
2118void sqlite3VtabFinishParse(Parse*, Token*);
2119void sqlite3VtabArgInit(Parse*);
2120void sqlite3VtabArgExtend(Parse*, Token*);
danielk197778efaba2006-06-12 06:09:17 +00002121int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
danielk19777e6ebfb2006-06-12 11:24:37 +00002122int sqlite3VtabCallConnect(Parse*, Table*);
danielk19779e39ce82006-06-12 16:01:21 +00002123int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
danielk1977f9e7dda2006-06-16 16:08:53 +00002124int sqlite3VtabBegin(sqlite3 *, sqlite3_vtab *);
danielk19771e536952007-08-16 10:09:01 +00002125FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
drhb7481e72006-09-16 21:45:14 +00002126void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
drhb900aaf2006-11-09 00:24:53 +00002127int sqlite3Reprepare(Vdbe*);
drhb1a6c3c2008-03-20 16:30:17 +00002128void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*);
drh0a0e1312007-08-07 17:04:59 +00002129CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
drhb9bb7c12006-06-11 23:41:55 +00002130
drh643167f2008-01-22 21:30:53 +00002131
2132/*
2133** Available fault injectors. Should be numbered beginning with 0.
2134*/
2135#define SQLITE_FAULTINJECTOR_MALLOC 0
drh7e8b8482008-01-23 03:03:05 +00002136#define SQLITE_FAULTINJECTOR_COUNT 1
drh643167f2008-01-22 21:30:53 +00002137
2138/*
2139** The interface to the fault injector subsystem. If the fault injector
2140** mechanism is disabled at compile-time then set up macros so that no
2141** unnecessary code is generated.
2142*/
drh3088d592008-03-21 16:45:47 +00002143#ifndef SQLITE_OMIT_BUILTIN_TEST
drh643167f2008-01-22 21:30:53 +00002144 void sqlite3FaultConfig(int,int,int);
2145 int sqlite3FaultFailures(int);
2146 int sqlite3FaultBenignFailures(int);
2147 int sqlite3FaultPending(int);
2148 void sqlite3FaultBenign(int,int);
2149 int sqlite3FaultStep(int);
2150#else
2151# define sqlite3FaultConfig(A,B,C)
2152# define sqlite3FaultFailures(A) 0
2153# define sqlite3FaultBenignFailures(A) 0
2154# define sqlite3FaultPending(A) (-1)
2155# define sqlite3FaultBenign(A,B)
2156# define sqlite3FaultStep(A) 0
2157#endif
2158
2159
2160
danielk19779a96b662007-11-29 17:05:18 +00002161#define IN_INDEX_ROWID 1
2162#define IN_INDEX_EPH 2
2163#define IN_INDEX_INDEX 3
2164int sqlite3FindInIndex(Parse *, Expr *, int);
2165
danielk1977c7b60172007-08-22 11:22:03 +00002166#ifdef SQLITE_ENABLE_ATOMIC_WRITE
2167 int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
2168 int sqlite3JournalSize(sqlite3_vfs *);
danielk1977f55b8992007-08-24 08:15:53 +00002169 int sqlite3JournalCreate(sqlite3_file *);
danielk1977c7b60172007-08-22 11:22:03 +00002170#else
2171 #define sqlite3JournalSize(pVfs) ((pVfs)->szOsFile)
2172#endif
2173
danielk1977e6a58a42007-08-31 17:42:48 +00002174#if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
danielk1977fc976062007-05-10 10:46:56 +00002175 void sqlite3ExprSetHeight(Expr *);
2176 int sqlite3SelectExprHeight(Select *);
2177#else
2178 #define sqlite3ExprSetHeight(x)
2179#endif
2180
drha3152892007-05-05 11:48:52 +00002181u32 sqlite3Get4byte(const u8*);
drha3152892007-05-05 11:48:52 +00002182void sqlite3Put4byte(u8*, u32);
2183
danielk1977fd9a0a42005-05-24 12:01:00 +00002184#ifdef SQLITE_SSE
2185#include "sseInt.h"
2186#endif
2187
drh6e736832007-05-11 12:30:03 +00002188#ifdef SQLITE_DEBUG
2189 void sqlite3ParserTrace(FILE*, char *);
2190#endif
2191
drhb0603412007-02-28 04:47:26 +00002192/*
2193** If the SQLITE_ENABLE IOTRACE exists then the global variable
mlcreech3a00f902008-03-04 17:45:01 +00002194** sqlite3IoTrace is a pointer to a printf-like routine used to
drhb0603412007-02-28 04:47:26 +00002195** print I/O tracing messages.
2196*/
2197#ifdef SQLITE_ENABLE_IOTRACE
mlcreech3a00f902008-03-04 17:45:01 +00002198# define IOTRACE(A) if( sqlite3IoTrace ){ sqlite3IoTrace A; }
danielk1977b4622b62007-03-02 06:24:19 +00002199 void sqlite3VdbeIOTraceSql(Vdbe*);
drhb0603412007-02-28 04:47:26 +00002200#else
2201# define IOTRACE(A)
danielk1977b4622b62007-03-02 06:24:19 +00002202# define sqlite3VdbeIOTraceSql(X)
drhb0603412007-02-28 04:47:26 +00002203#endif
mlcreech3a00f902008-03-04 17:45:01 +00002204SQLITE_EXTERN void (*sqlite3IoTrace)(const char*,...);
drhb0603412007-02-28 04:47:26 +00002205
danielk1977e3026632004-06-22 11:29:02 +00002206#endif