4
** The author disclaims copyright to this source code. In place of
5
** a legal notice, here is a blessing:
7
** 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.
11
*************************************************************************
12
** Internal interface definitions for SQLite.
14
** @(#) $Id: sqliteInt.h,v 1.375 2005/03/29 03:10:59 danielk1977 Exp $
20
** These #defines should enable >2GB file support on Posix if the
21
** underlying operating system supports it. If the OS lacks
22
** large file support, or if the OS is windows, these should be no-ops.
24
** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
25
** on the compiler command line. This is necessary if you are compiling
26
** on a recent machine (ex: RedHat 7.2) but you want your code to work
27
** on an older machine (ex: RedHat 6.0). If you compile on RedHat 7.2
28
** without this option, LFS is enable. But LFS does not exist in the kernel
29
** in RedHat 6.0, so the code won't work. Hence, for maximum binary
30
** portability you should omit LFS.
32
** Similar is true for MacOS. LFS is only supported on MacOS 9 and later.
34
#ifndef SQLITE_DISABLE_LFS
35
# define _LARGE_FILE 1
36
# ifndef _FILE_OFFSET_BITS
37
# define _FILE_OFFSET_BITS 64
39
# define _LARGEFILE_SOURCE 1
53
** The maximum number of in-memory pages to use for the main database
54
** table and for temporary tables. Internally, the MAX_PAGES and
55
** TEMP_PAGES macros are used. To override the default values at
56
** compilation time, the SQLITE_DEFAULT_CACHE_SIZE and
57
** SQLITE_DEFAULT_TEMP_CACHE_SIZE macros should be set.
59
#ifdef SQLITE_DEFAULT_CACHE_SIZE
60
# define MAX_PAGES SQLITE_DEFAULT_CACHE_SIZE
62
# define MAX_PAGES 2000
64
#ifdef SQLITE_DEFAULT_TEMP_CACHE_SIZE
65
# define TEMP_PAGES SQLITE_DEFAULT_TEMP_CACHE_SIZE
67
# define TEMP_PAGES 500
71
** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
72
** afterward. Having this macro allows us to cause the C compiler
73
** to omit code used by TEMP tables without messy #ifndef statements.
75
#ifdef SQLITE_OMIT_TEMPDB
82
** If the following macro is set to 1, then NULL values are considered
83
** distinct for the SELECT DISTINCT statement and for UNION or EXCEPT
84
** compound queries. No other SQL database engine (among those tested)
85
** works this way except for OCELOT. But the SQL92 spec implies that
86
** this is how things should work.
88
** If the following macro is set to 0, then NULLs are indistinct for
89
** SELECT DISTINCT and for UNION.
91
#define NULL_ALWAYS_DISTINCT 0
94
** If the following macro is set to 1, then NULL values are considered
95
** distinct when determining whether or not two entries are the same
96
** in a UNIQUE index. This is the way PostgreSQL, Oracle, DB2, MySQL,
97
** OCELOT, and Firebird all work. The SQL92 spec explicitly says this
98
** is the way things are suppose to work.
100
** If the following macro is set to 0, the NULLs are indistinct for
101
** a UNIQUE index. In this mode, you can only have a single NULL entry
102
** for a column declared UNIQUE. This is the way Informix and SQL Server
105
#define NULL_DISTINCT_FOR_UNIQUE 1
108
** The maximum number of attached databases. This must be at least 2
109
** in order to support the main database file (0) and the file used to
110
** hold temporary tables (1). And it must be less than 32 because
111
** we use a bitmask of databases with a u32 in places (for example
112
** the Parse.cookieMask field).
114
#define MAX_ATTACHED 10
117
** The maximum value of a ?nnn wildcard that the parser will accept.
119
#define SQLITE_MAX_VARIABLE_NUMBER 999
122
** When building SQLite for embedded systems where memory is scarce,
123
** you can define one or more of the following macros to omit extra
124
** features of the library and thus keep the size of the library to
127
/* #define SQLITE_OMIT_AUTHORIZATION 1 */
128
/* #define SQLITE_OMIT_MEMORYDB 1 */
129
/* #define SQLITE_OMIT_VACUUM 1 */
130
/* #define SQLITE_OMIT_DATETIME_FUNCS 1 */
131
/* #define SQLITE_OMIT_PROGRESS_CALLBACK 1 */
132
/* #define SQLITE_OMIT_AUTOVACUUM */
133
/* #define SQLITE_OMIT_ALTERTABLE */
136
** Provide a default value for TEMP_STORE in case it is not specified
137
** on the command-line
140
# define TEMP_STORE 1
144
** GCC does not define the offsetof() macro so we'll have to do it
148
#define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
152
** Integers of known sizes. These typedefs might change for architectures
153
** where the sizes very. Preprocessor macros are available so that the
154
** types can be conveniently redefined at compile-type. Like this:
156
** cc '-DUINTPTR_TYPE=long long int' ...
159
# if defined(_MSC_VER) || defined(__BORLANDC__)
160
# define UINT64_TYPE unsigned __int64
162
# define UINT64_TYPE unsigned long long int
166
# define UINT32_TYPE unsigned int
169
# define UINT16_TYPE unsigned short int
172
# define INT16_TYPE short int
175
# define UINT8_TYPE unsigned char
178
# define INT8_TYPE signed char
180
#ifndef LONGDOUBLE_TYPE
181
# define LONGDOUBLE_TYPE long double
184
# if SQLITE_PTR_SZ==4
185
# define INTPTR_TYPE int
187
# define INTPTR_TYPE sqlite_int64
191
# if SQLITE_PTR_SZ==4
192
# define UINTPTR_TYPE unsigned int
194
# define UINTPTR_TYPE sqlite_uint64
197
typedef sqlite_int64 i64; /* 8-byte signed integer */
198
typedef UINT64_TYPE u64; /* 8-byte unsigned integer */
199
typedef UINT32_TYPE u32; /* 4-byte unsigned integer */
200
typedef UINT16_TYPE u16; /* 2-byte unsigned integer */
201
typedef INT16_TYPE i16; /* 2-byte signed integer */
202
typedef UINT8_TYPE u8; /* 1-byte unsigned integer */
203
typedef UINT8_TYPE i8; /* 1-byte signed integer */
204
typedef INTPTR_TYPE ptr; /* Big enough to hold a pointer */
205
typedef UINTPTR_TYPE uptr; /* Big enough to hold a pointer */
208
** Macros to determine whether the machine is big or little endian,
209
** evaluated at runtime.
211
extern const int sqlite3one;
212
#define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0)
213
#define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
216
** An instance of the following structure is used to store the busy-handler
217
** callback for a given sqlite handle.
219
** The sqlite.busyHandler member of the sqlite struct contains the busy
220
** callback for the database handle. Each pager opened via the sqlite
221
** handle is passed a pointer to sqlite.busyHandler. The busy-handler
222
** callback is currently invoked only from within pager.c.
224
typedef struct BusyHandler BusyHandler;
226
int (*xFunc)(void *,int); /* The busy callback */
227
void *pArg; /* First arg to busy callback */
231
** Defer sourcing vdbe.h and btree.h until after the "u8" and
232
** "BusyHandler typedefs.
238
** This macro casts a pointer to an integer. Useful for doing
239
** pointer arithmetic.
241
#define Addr(X) ((uptr)X)
244
** If memory allocation problems are found, recompile with
248
** to enable some sanity checking on malloc() and free(). To
249
** check for memory leaks, recompile with
253
** and a line of text will be written to standard error for
254
** each malloc() and free(). This output can be analyzed
255
** by an AWK script to determine if there are any leaks.
257
#ifdef SQLITE_MEMDEBUG
258
# define sqliteMalloc(X) sqlite3Malloc_(X,1,__FILE__,__LINE__)
259
# define sqliteMallocRaw(X) sqlite3Malloc_(X,0,__FILE__,__LINE__)
260
# define sqliteFree(X) sqlite3Free_(X,__FILE__,__LINE__)
261
# define sqliteRealloc(X,Y) sqlite3Realloc_(X,Y,__FILE__,__LINE__)
262
# define sqliteStrDup(X) sqlite3StrDup_(X,__FILE__,__LINE__)
263
# define sqliteStrNDup(X,Y) sqlite3StrNDup_(X,Y,__FILE__,__LINE__)
265
# define sqliteFree sqlite3FreeX
266
# define sqliteMalloc sqlite3Malloc
267
# define sqliteMallocRaw sqlite3MallocRaw
268
# define sqliteRealloc sqlite3Realloc
269
# define sqliteStrDup sqlite3StrDup
270
# define sqliteStrNDup sqlite3StrNDup
274
** This variable gets set if malloc() ever fails. After it gets set,
275
** the SQLite library shuts down permanently.
277
extern int sqlite3_malloc_failed;
280
** The following global variables are used for testing and debugging
281
** only. They only work if SQLITE_DEBUG is defined.
283
#ifdef SQLITE_MEMDEBUG
284
extern int sqlite3_nMalloc; /* Number of sqliteMalloc() calls */
285
extern int sqlite3_nFree; /* Number of sqliteFree() calls */
286
extern int sqlite3_iMallocFail; /* Fail sqliteMalloc() after this many calls */
287
extern int sqlite3_iMallocReset; /* Set iMallocFail to this when it reaches 0 */
291
** Name of the master database table. The master database table
292
** is a special table that holds the names and attributes of all
293
** user tables and indices.
295
#define MASTER_NAME "sqlite_master"
296
#define TEMP_MASTER_NAME "sqlite_temp_master"
299
** The root-page of the master database table.
301
#define MASTER_ROOT 1
304
** The name of the schema table.
306
#define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
309
** A convenience macro that returns the number of elements in
312
#define ArraySize(X) (sizeof(X)/sizeof(X[0]))
315
** Forward references to structures
317
typedef struct Column Column;
318
typedef struct Table Table;
319
typedef struct Index Index;
320
typedef struct Instruction Instruction;
321
typedef struct Expr Expr;
322
typedef struct ExprList ExprList;
323
typedef struct Parse Parse;
324
typedef struct Token Token;
325
typedef struct IdList IdList;
326
typedef struct SrcList SrcList;
327
typedef struct WhereInfo WhereInfo;
328
typedef struct WhereLevel WhereLevel;
329
typedef struct Select Select;
330
typedef struct AggExpr AggExpr;
331
typedef struct FuncDef FuncDef;
332
typedef struct Trigger Trigger;
333
typedef struct TriggerStep TriggerStep;
334
typedef struct TriggerStack TriggerStack;
335
typedef struct FKey FKey;
336
typedef struct Db Db;
337
typedef struct AuthContext AuthContext;
338
typedef struct KeyClass KeyClass;
339
typedef struct CollSeq CollSeq;
340
typedef struct KeyInfo KeyInfo;
341
typedef struct NameContext NameContext;
342
typedef struct Fetch Fetch;
345
** Each database file to be accessed by the system is an instance
346
** of the following structure. There are normally two of these structures
347
** in the sqlite.aDb[] array. aDb[0] is the main database file and
348
** aDb[1] is the database file used to hold temporary tables. Additional
349
** databases may be attached.
352
char *zName; /* Name of this database */
353
Btree *pBt; /* The B*Tree structure for this database file */
354
int schema_cookie; /* Database schema version number for this file */
355
Hash tblHash; /* All tables indexed by name */
356
Hash idxHash; /* All (named) indices indexed by name */
357
Hash trigHash; /* All triggers indexed by name */
358
Hash aFKey; /* Foreign keys indexed by to-table */
359
u16 flags; /* Flags associated with this database */
360
u8 inTrans; /* 0: not writable. 1: Transaction. 2: Checkpoint */
361
u8 safety_level; /* How aggressive at synching data to disk */
362
int cache_size; /* Number of pages to use in the cache */
363
Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */
364
void *pAux; /* Auxiliary data. Usually NULL */
365
void (*xFreeAux)(void*); /* Routine to free pAux */
369
** These macros can be used to test, set, or clear bits in the
372
#define DbHasProperty(D,I,P) (((D)->aDb[I].flags&(P))==(P))
373
#define DbHasAnyProperty(D,I,P) (((D)->aDb[I].flags&(P))!=0)
374
#define DbSetProperty(D,I,P) (D)->aDb[I].flags|=(P)
375
#define DbClearProperty(D,I,P) (D)->aDb[I].flags&=~(P)
378
** Allowed values for the DB.flags field.
380
** The DB_SchemaLoaded flag is set after the database schema has been
381
** read into internal hash tables.
383
** DB_UnresetViews means that one or more views have column names that
384
** have been filled out. If the schema changes, these column names might
385
** changes and so the view will need to be reset.
387
#define DB_SchemaLoaded 0x0001 /* The schema has been loaded */
388
#define DB_UnresetViews 0x0002 /* Some views have defined column names */
390
#define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
393
** Each database is an instance of the following structure.
395
** The sqlite.lastRowid records the last insert rowid generated by an
396
** insert statement. Inserts on views do not affect its value. Each
397
** trigger has its own context, so that lastRowid can be updated inside
398
** triggers as usual. The previous value will be restored once the trigger
399
** exits. Upon entering a before or instead of trigger, lastRowid is no
400
** longer (since after version 2.8.12) reset to -1.
402
** The sqlite.nChange does not count changes within triggers and keeps no
403
** context. It is reset at start of sqlite3_exec.
404
** The sqlite.lsChange represents the number of changes made by the last
405
** insert, update, or delete statement. It remains constant throughout the
406
** length of a statement and is then updated by OP_SetCounts. It keeps a
407
** context stack just like lastRowid so that the count of changes
408
** within a trigger is not seen outside the trigger. Changes to views do not
409
** affect the value of lsChange.
410
** The sqlite.csChange keeps track of the number of current changes (since
411
** the last statement) and is used to update sqlite_lsChange.
413
** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
414
** store the most recent error code and, if applicable, string. The
415
** internal function sqlite3Error() is used to set these variables
419
int nDb; /* Number of backends currently in use */
420
Db *aDb; /* All backends */
421
Db aDbStatic[2]; /* Static space for the 2 default backends */
422
int flags; /* Miscellanous flags. See below */
423
u8 file_format; /* What file format version is this database? */
424
u8 temp_store; /* 1: file 2: memory 0: default */
425
int nTable; /* Number of tables in the database */
426
BusyHandler busyHandler; /* Busy callback */
427
void *pCommitArg; /* Argument to xCommitCallback() */
428
int (*xCommitCallback)(void*);/* Invoked at every commit. */
429
Hash aFunc; /* All functions that can be in SQL exprs */
430
Hash aCollSeq; /* All collating sequences */
431
CollSeq *pDfltColl; /* The default collating sequence (BINARY) */
432
i64 lastRowid; /* ROWID of most recent insert (see above) */
433
i64 priorNewRowid; /* Last randomly generated ROWID */
434
int magic; /* Magic number for detect library misuse */
435
int nChange; /* Value returned by sqlite3_changes() */
436
int nTotalChange; /* Value returned by sqlite3_total_changes() */
437
struct sqlite3InitInfo { /* Information used during initialization */
438
int iDb; /* When back is being initialized */
439
int newTnum; /* Rootpage of table being initialized */
440
u8 busy; /* TRUE if currently initializing */
442
struct Vdbe *pVdbe; /* List of active virtual machines */
443
int activeVdbeCnt; /* Number of vdbes currently executing */
444
void (*xTrace)(void*,const char*); /* Trace function */
445
void *pTraceArg; /* Argument to the trace function */
446
#ifndef SQLITE_OMIT_AUTHORIZATION
447
int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
448
/* Access authorization function */
449
void *pAuthArg; /* 1st argument to the access auth function */
451
#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
452
int (*xProgress)(void *); /* The progress callback */
453
void *pProgressArg; /* Argument to the progress callback */
454
int nProgressOps; /* Number of opcodes for progress callback */
456
int errCode; /* Most recent error code (SQLITE_*) */
457
u8 enc; /* Text encoding for this database. */
458
u8 autoCommit; /* The auto-commit flag. */
459
void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
460
void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
461
void *pCollNeededArg;
462
sqlite3_value *pValue; /* Value used for transient conversions */
463
sqlite3_value *pErr; /* Most recent error message */
464
char *zErrMsg; /* Most recent error message (UTF-8 encoded) */
465
char *zErrMsg16; /* Most recent error message (UTF-16 encoded) */
466
#ifndef SQLITE_OMIT_GLOBALRECOVER
467
sqlite3 *pNext; /* Linked list of open db handles. */
472
** Possible values for the sqlite.flags and or Db.flags fields.
474
** On sqlite.flags, the SQLITE_InTrans value means that we have
475
** executed a BEGIN. On Db.flags, SQLITE_InTrans means a statement
476
** transaction is active on that particular database file.
478
#define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */
479
#define SQLITE_Initialized 0x00000002 /* True after initialization */
480
#define SQLITE_Interrupt 0x00000004 /* Cancel current operation */
481
#define SQLITE_InTrans 0x00000008 /* True if in a transaction */
482
#define SQLITE_InternChanges 0x00000010 /* Uncommitted Hash table changes */
483
#define SQLITE_FullColNames 0x00000020 /* Show full column names on SELECT */
484
#define SQLITE_ShortColNames 0x00000040 /* Show short columns names */
485
#define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */
486
/* DELETE, or UPDATE and return */
487
/* the count using a callback. */
488
#define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */
489
/* result set is empty */
490
#define SQLITE_SqlTrace 0x00000200 /* Debug print SQL as it executes */
491
#define SQLITE_VdbeListing 0x00000400 /* Debug listings of VDBE programs */
492
#define SQLITE_WriteSchema 0x00000800 /* OK to update SQLITE_MASTER */
493
#define SQLITE_NoReadlock 0x00001000 /* Readlocks are omitted when
494
** accessing read-only databases */
497
** Possible values for the sqlite.magic field.
498
** The numbers are obtained at random and have no special meaning, other
499
** than being distinct from one another.
501
#define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */
502
#define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */
503
#define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */
504
#define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */
507
** Each SQL function is defined by an instance of the following
508
** structure. A pointer to this structure is stored in the sqlite.aFunc
509
** hash table. When multiple functions have the same name, the hash table
510
** points to a linked list of these structures.
513
char *zName; /* SQL name of the function */
514
int nArg; /* Number of arguments. -1 means unlimited */
515
u8 iPrefEnc; /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
516
void *pUserData; /* User data parameter */
517
FuncDef *pNext; /* Next function with same name */
518
void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
519
void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
520
void (*xFinalize)(sqlite3_context*); /* Aggregate finializer */
521
u8 needCollSeq; /* True if sqlite3GetFuncCollSeq() might be called */
525
** information about each column of an SQL table is held in an instance
526
** of this structure.
529
char *zName; /* Name of this column */
530
Expr *pDflt; /* Default value of this column */
531
char *zType; /* Data type for this column */
532
CollSeq *pColl; /* Collating sequence. If NULL, use the default */
533
u8 notNull; /* True if there is a NOT NULL constraint */
534
u8 isPrimKey; /* True if this column is part of the PRIMARY KEY */
535
char affinity; /* One of the SQLITE_AFF_... values */
539
** A "Collating Sequence" is defined by an instance of the following
540
** structure. Conceptually, a collating sequence consists of a name and
541
** a comparison routine that defines the order of that sequence.
543
** There may two seperate implementations of the collation function, one
544
** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
545
** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
546
** native byte order. When a collation sequence is invoked, SQLite selects
547
** the version that will require the least expensive encoding
548
** transalations, if any.
550
** The CollSeq.pUser member variable is an extra parameter that passed in
551
** as the first argument to the UTF-8 comparison function, xCmp.
552
** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
555
** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
556
** collating sequence is undefined. Indices built on an undefined
557
** collating sequence may not be read or written.
560
char *zName; /* Name of the collating sequence, UTF-8 encoded */
561
u8 enc; /* Text encoding handled by xCmp() */
562
void *pUser; /* First argument to xCmp() */
563
int (*xCmp)(void*,int, const void*, int, const void*);
567
** A sort order can be either ASC or DESC.
569
#define SQLITE_SO_ASC 0 /* Sort in ascending order */
570
#define SQLITE_SO_DESC 1 /* Sort in ascending order */
573
** Column affinity types.
575
#define SQLITE_AFF_INTEGER 'i'
576
#define SQLITE_AFF_NUMERIC 'n'
577
#define SQLITE_AFF_TEXT 't'
578
#define SQLITE_AFF_NONE 'o'
582
** Each SQL table is represented in memory by an instance of the
583
** following structure.
585
** Table.zName is the name of the table. The case of the original
586
** CREATE TABLE statement is stored, but case is not significant for
589
** Table.nCol is the number of columns in this table. Table.aCol is a
590
** pointer to an array of Column structures, one for each column.
592
** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
593
** the column that is that key. Otherwise Table.iPKey is negative. Note
594
** that the datatype of the PRIMARY KEY must be INTEGER for this field to
595
** be set. An INTEGER PRIMARY KEY is used as the rowid for each row of
596
** the table. If a table has no INTEGER PRIMARY KEY, then a random rowid
597
** is generated for each row of the table. Table.hasPrimKey is true if
598
** the table has any PRIMARY KEY, INTEGER or otherwise.
600
** Table.tnum is the page number for the root BTree page of the table in the
601
** database file. If Table.iDb is the index of the database table backend
602
** in sqlite.aDb[]. 0 is for the main database and 1 is for the file that
603
** holds temporary tables and indices. If Table.isTransient
604
** is true, then the table is stored in a file that is automatically deleted
605
** when the VDBE cursor to the table is closed. In this case Table.tnum
606
** refers VDBE cursor number that holds the table open, not to the root
607
** page number. Transient tables are used to hold the results of a
608
** sub-query that appears instead of a real table name in the FROM clause
609
** of a SELECT statement.
612
char *zName; /* Name of the table */
613
int nCol; /* Number of columns in this table */
614
Column *aCol; /* Information about each column */
615
int iPKey; /* If not less then 0, use aCol[iPKey] as the primary key */
616
Index *pIndex; /* List of SQL indexes on this table. */
617
int tnum; /* Root BTree node for this table (see note above) */
618
Select *pSelect; /* NULL for tables. Points to definition if a view. */
619
u8 readOnly; /* True if this table should not be written by the user */
620
u8 iDb; /* Index into sqlite.aDb[] of the backend for this table */
621
u8 isTransient; /* True if automatically deleted when VDBE finishes */
622
u8 hasPrimKey; /* True if there exists a primary key */
623
u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */
624
u8 autoInc; /* True if the integer primary key is autoincrement */
625
Trigger *pTrigger; /* List of SQL triggers on this table */
626
FKey *pFKey; /* Linked list of all foreign keys in this table */
627
char *zColAff; /* String defining the affinity of each column */
628
#ifndef SQLITE_OMIT_ALTERTABLE
629
int addColOffset; /* Offset in CREATE TABLE statement to add a new column */
634
** Each foreign key constraint is an instance of the following structure.
636
** A foreign key is associated with two tables. The "from" table is
637
** the table that contains the REFERENCES clause that creates the foreign
638
** key. The "to" table is the table that is named in the REFERENCES clause.
639
** Consider this example:
642
** a INTEGER PRIMARY KEY,
643
** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
646
** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
648
** Each REFERENCES clause generates an instance of the following structure
649
** which is attached to the from-table. The to-table need not exist when
650
** the from-table is created. The existance of the to-table is not checked
651
** until an attempt is made to insert data into the from-table.
653
** The sqlite.aFKey hash table stores pointers to this structure
654
** given the name of a to-table. For each to-table, all foreign keys
655
** associated with that table are on a linked list using the FKey.pNextTo
659
Table *pFrom; /* The table that constains the REFERENCES clause */
660
FKey *pNextFrom; /* Next foreign key in pFrom */
661
char *zTo; /* Name of table that the key points to */
662
FKey *pNextTo; /* Next foreign key that points to zTo */
663
int nCol; /* Number of columns in this key */
664
struct sColMap { /* Mapping of columns in pFrom to columns in zTo */
665
int iFrom; /* Index of column in pFrom */
666
char *zCol; /* Name of column in zTo. If 0 use PRIMARY KEY */
667
} *aCol; /* One entry for each of nCol column s */
668
u8 isDeferred; /* True if constraint checking is deferred till COMMIT */
669
u8 updateConf; /* How to resolve conflicts that occur on UPDATE */
670
u8 deleteConf; /* How to resolve conflicts that occur on DELETE */
671
u8 insertConf; /* How to resolve conflicts that occur on INSERT */
675
** SQLite supports many different ways to resolve a contraint
676
** error. ROLLBACK processing means that a constraint violation
677
** causes the operation in process to fail and for the current transaction
678
** to be rolled back. ABORT processing means the operation in process
679
** fails and any prior changes from that one operation are backed out,
680
** but the transaction is not rolled back. FAIL processing means that
681
** the operation in progress stops and returns an error code. But prior
682
** changes due to the same operation are not backed out and no rollback
683
** occurs. IGNORE means that the particular row that caused the constraint
684
** error is not inserted or updated. Processing continues and no error
685
** is returned. REPLACE means that preexisting database rows that caused
686
** a UNIQUE constraint violation are removed so that the new insert or
687
** update can proceed. Processing continues and no error is reported.
689
** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
690
** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
691
** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign
692
** key is set to NULL. CASCADE means that a DELETE or UPDATE of the
693
** referenced table row is propagated into the row that holds the
696
** The following symbolic values are used to record which type
697
** of action to take.
699
#define OE_None 0 /* There is no constraint to check */
700
#define OE_Rollback 1 /* Fail the operation and rollback the transaction */
701
#define OE_Abort 2 /* Back out changes but do no rollback transaction */
702
#define OE_Fail 3 /* Stop the operation but leave all prior changes */
703
#define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */
704
#define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */
706
#define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
707
#define OE_SetNull 7 /* Set the foreign key value to NULL */
708
#define OE_SetDflt 8 /* Set the foreign key value to its default */
709
#define OE_Cascade 9 /* Cascade the changes */
711
#define OE_Default 99 /* Do whatever the default action is */
715
** An instance of the following structure is passed as the first
716
** argument to sqlite3VdbeKeyCompare and is used to control the
717
** comparison of the two index keys.
719
** If the KeyInfo.incrKey value is true and the comparison would
720
** otherwise be equal, then return a result as if the second key larger.
723
u8 enc; /* Text encoding - one of the TEXT_Utf* values */
724
u8 incrKey; /* Increase 2nd key by epsilon before comparison */
725
int nField; /* Number of entries in aColl[] */
726
u8 *aSortOrder; /* If defined an aSortOrder[i] is true, sort DESC */
727
CollSeq *aColl[1]; /* Collating sequence for each term of the key */
731
** Each SQL index is represented in memory by an
732
** instance of the following structure.
734
** The columns of the table that are to be indexed are described
735
** by the aiColumn[] field of this structure. For example, suppose
736
** we have the following table and index:
738
** CREATE TABLE Ex1(c1 int, c2 int, c3 text);
739
** CREATE INDEX Ex2 ON Ex1(c3,c1);
741
** In the Table structure describing Ex1, nCol==3 because there are
742
** three columns in the table. In the Index structure describing
743
** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
744
** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the
745
** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
746
** The second column to be indexed (c1) has an index of 0 in
747
** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
749
** The Index.onError field determines whether or not the indexed columns
750
** must be unique and what to do if they are not. When Index.onError=OE_None,
751
** it means this is not a unique index. Otherwise it is a unique index
752
** and the value of Index.onError indicate the which conflict resolution
753
** algorithm to employ whenever an attempt is made to insert a non-unique
757
char *zName; /* Name of this index */
758
int nColumn; /* Number of columns in the table used by this index */
759
int *aiColumn; /* Which columns are used by this index. 1st is 0 */
760
Table *pTable; /* The SQL table being indexed */
761
int tnum; /* Page containing root of this index in database file */
762
u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
763
u8 autoIndex; /* True if is automatically created (ex: by UNIQUE) */
764
u8 iDb; /* Index in sqlite.aDb[] of where this index is stored */
765
char *zColAff; /* String defining the affinity of each column */
766
Index *pNext; /* The next index associated with the same table */
767
KeyInfo keyInfo; /* Info on how to order keys. MUST BE LAST */
771
** Each token coming out of the lexer is an instance of
772
** this structure. Tokens are also used as part of an expression.
774
** Note if Token.z==0 then Token.dyn and Token.n are undefined and
775
** may contain random values. Do not make any assuptions about Token.dyn
776
** and Token.n when Token.z==0.
779
const unsigned char *z; /* Text of the token. Not NULL-terminated! */
780
unsigned dyn : 1; /* True for malloced memory, false for static */
781
unsigned n : 31; /* Number of characters in this token */
785
** Each node of an expression in the parse tree is an instance
786
** of this structure.
788
** Expr.op is the opcode. The integer parser token codes are reused
789
** as opcodes here. For example, the parser defines TK_GE to be an integer
790
** code representing the ">=" operator. This same integer code is reused
791
** to represent the greater-than-or-equal-to operator in the expression
794
** Expr.pRight and Expr.pLeft are subexpressions. Expr.pList is a list
795
** of argument if the expression is a function.
797
** Expr.token is the operator token for this node. For some expressions
798
** that have subexpressions, Expr.token can be the complete text that gave
799
** rise to the Expr. In the latter case, the token is marked as being
802
** An expression of the form ID or ID.ID refers to a column in a table.
803
** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
804
** the integer cursor number of a VDBE cursor pointing to that table and
805
** Expr.iColumn is the column number for the specific column. If the
806
** expression is used as a result in an aggregate SELECT, then the
807
** value is also stored in the Expr.iAgg column in the aggregate so that
808
** it can be accessed after all aggregates are computed.
810
** If the expression is a function, the Expr.iTable is an integer code
811
** representing which function. If the expression is an unbound variable
812
** marker (a question mark character '?' in the original SQL) then the
813
** Expr.iTable holds the index number for that variable.
815
** If the expression is a subquery then Expr.iColumn holds an integer
816
** register number containing the result of the subquery. If the
817
** subquery gives a constant result, then iTable is -1. If the subquery
818
** gives a different answer at different times during statement processing
819
** then iTable is the address of a subroutine that computes the subquery.
821
** The Expr.pSelect field points to a SELECT statement. The SELECT might
822
** be the right operand of an IN operator. Or, if a scalar SELECT appears
823
** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
826
** If the Expr is of type OP_Column, and the table it is selecting from
827
** is a disk table or the "old.*" pseudo-table, then pTab points to the
828
** corresponding table definition.
831
u8 op; /* Operation performed by this node */
832
char affinity; /* The affinity of the column or 0 if not a column */
833
u8 iDb; /* Database referenced by this expression */
834
u8 flags; /* Various flags. See below */
835
CollSeq *pColl; /* The collation type of the column or 0 */
836
Expr *pLeft, *pRight; /* Left and right subnodes */
837
ExprList *pList; /* A list of expressions used as function arguments
838
** or in "<expr> IN (<expr-list)" */
839
Token token; /* An operand token */
840
Token span; /* Complete text of the expression */
841
int iTable, iColumn; /* When op==TK_COLUMN, then this expr node means the
842
** iColumn-th field of the iTable-th table. */
843
int iAgg; /* When op==TK_COLUMN and pParse->fillAgg==FALSE, pull
844
** result from the iAgg-th element of the aggregator */
845
int iAggCtx; /* The value to pass as P1 of OP_AggGet. */
846
Select *pSelect; /* When the expression is a sub-select. Also the
847
** right side of "<expr> IN (<select>)" */
848
Table *pTab; /* Table for OP_Column expressions. */
852
** The following are the meanings of bits in the Expr.flags field.
854
#define EP_FromJoin 0x0001 /* Originated in ON or USING clause of a join */
855
#define EP_Agg 0x0002 /* Contains one or more aggregate functions */
856
#define EP_Resolved 0x0004 /* IDs have been resolved to COLUMNs */
857
#define EP_Error 0x0008 /* Expression contains one or more errors */
858
#define EP_Not 0x0010 /* Operator preceeded by NOT */
859
#define EP_VarSelect 0x0020 /* pSelect is correlated, not constant */
862
** These macros can be used to test, set, or clear bits in the
865
#define ExprHasProperty(E,P) (((E)->flags&(P))==(P))
866
#define ExprHasAnyProperty(E,P) (((E)->flags&(P))!=0)
867
#define ExprSetProperty(E,P) (E)->flags|=(P)
868
#define ExprClearProperty(E,P) (E)->flags&=~(P)
871
** A list of expressions. Each expression may optionally have a
872
** name. An expr/name combination can be used in several ways, such
873
** as the list of "expr AS ID" fields following a "SELECT" or in the
874
** list of "ID = expr" items in an UPDATE. A list of expressions can
875
** also be used as the argument to a function, in which case the a.zName
876
** field is not used.
879
int nExpr; /* Number of expressions on the list */
880
int nAlloc; /* Number of entries allocated below */
881
struct ExprList_item {
882
Expr *pExpr; /* The list of expressions */
883
char *zName; /* Token associated with this expression */
884
u8 sortOrder; /* 1 for DESC or 0 for ASC */
885
u8 isAgg; /* True if this is an aggregate like count(*) */
886
u8 done; /* A flag to indicate when processing is finished */
887
} *a; /* One entry for each expression */
891
** An instance of this structure can hold a simple list of identifiers,
892
** such as the list "a,b,c" in the following statements:
894
** INSERT INTO t(a,b,c) VALUES ...;
895
** CREATE INDEX idx ON t(a,b,c);
896
** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
898
** The IdList.a.idx field is used when the IdList represents the list of
899
** column names after a table name in an INSERT statement. In the statement
901
** INSERT INTO t(a,b,c) ...
903
** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
906
int nId; /* Number of identifiers on the list */
907
int nAlloc; /* Number of entries allocated for a[] below */
909
char *zName; /* Name of the identifier */
910
int idx; /* Index in some Table.aCol[] of a column named zName */
915
** The bitmask datatype defined below is used for various optimizations.
917
typedef unsigned int Bitmask;
920
** The following structure describes the FROM clause of a SELECT statement.
921
** Each table or subquery in the FROM clause is a separate element of
922
** the SrcList.a[] array.
924
** With the addition of multiple database support, the following structure
925
** can also be used to describe a particular table such as the table that
926
** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL,
927
** such a table must be a simple name: ID. But in SQLite, the table can
928
** now be identified by a database name, a dot, then the table name: ID.ID.
931
i16 nSrc; /* Number of tables or subqueries in the FROM clause */
932
i16 nAlloc; /* Number of entries allocated in a[] below */
933
struct SrcList_item {
934
char *zDatabase; /* Name of database holding this table */
935
char *zName; /* Name of the table */
936
char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */
937
Table *pTab; /* An SQL table corresponding to zName */
938
Select *pSelect; /* A SELECT statement used in place of a table name */
939
int jointype; /* Type of join between this table and the next */
940
int iCursor; /* The VDBE cursor number used to access this table */
941
Expr *pOn; /* The ON clause of a join */
942
IdList *pUsing; /* The USING clause of a join */
943
Bitmask colUsed; /* Bit N (1<<N) set if column N or pTab is used */
944
} a[1]; /* One entry for each identifier on the list */
948
** Permitted values of the SrcList.a.jointype field
950
#define JT_INNER 0x0001 /* Any kind of inner or cross join */
951
#define JT_NATURAL 0x0002 /* True for a "natural" join */
952
#define JT_LEFT 0x0004 /* Left outer join */
953
#define JT_RIGHT 0x0008 /* Right outer join */
954
#define JT_OUTER 0x0010 /* The "OUTER" keyword is present */
955
#define JT_ERROR 0x0020 /* unknown or unsupported join type */
958
** For each nested loop in a WHERE clause implementation, the WhereInfo
959
** structure contains a single instance of this structure. This structure
960
** is intended to be private the the where.c module and should not be
961
** access or modified by other modules.
964
int iMem; /* Memory cell used by this level */
965
Index *pIdx; /* Index used. NULL if no index */
966
int iTabCur; /* The VDBE cursor used to access the table */
967
int iIdxCur; /* The VDBE cursor used to acesss pIdx */
968
int score; /* How well this index scored */
969
int brk; /* Jump here to break out of the loop */
970
int cont; /* Jump here to continue with the next loop cycle */
971
int op, p1, p2; /* Opcode used to terminate the loop */
972
int iLeftJoin; /* Memory cell used to implement LEFT OUTER JOIN */
973
int top; /* First instruction of interior of the loop */
974
int inOp, inP1, inP2;/* Opcode used to implement an IN operator */
975
int bRev; /* Do the scan in the reverse direction */
979
** The WHERE clause processing routine has two halves. The
980
** first part does the start of the WHERE loop and the second
981
** half does the tail of the WHERE loop. An instance of
982
** this structure is returned by the first half and passed
983
** into the second half to give some continuity.
987
SrcList *pTabList; /* List of tables in the join */
988
int iTop; /* The very beginning of the WHERE loop */
989
int iContinue; /* Jump here to continue with next record */
990
int iBreak; /* Jump here to break out of the loop */
991
int nLevel; /* Number of nested loop */
992
WhereLevel a[1]; /* Information about each nest loop in the WHERE */
996
** A NameContext defines a context in which to resolve table and column
997
** names. The context consists of a list of tables (the pSrcList) field and
998
** a list of named expression (pEList). The named expression list may
999
** be NULL. The pSrc corresponds to the FROM clause of a SELECT or
1000
** to the table being operated on by INSERT, UPDATE, or DELETE. The
1001
** pEList corresponds to the result set of a SELECT and is NULL for
1002
** other statements.
1004
** NameContexts can be nested. When resolving names, the inner-most
1005
** context is searched first. If no match is found, the next outer
1006
** context is checked. If there is still no match, the next context
1007
** is checked. This process continues until either a match is found
1008
** or all contexts are check. When a match is found, the nRef member of
1009
** the context containing the match is incremented.
1011
** Each subquery gets a new NameContext. The pNext field points to the
1012
** NameContext in the parent query. Thus the process of scanning the
1013
** NameContext list corresponds to searching through successively outer
1014
** subqueries looking for a match.
1016
struct NameContext {
1017
Parse *pParse; /* The parser */
1018
SrcList *pSrcList; /* One or more tables used to resolve names */
1019
ExprList *pEList; /* Optional list of named expressions */
1020
int nRef; /* Number of names resolved by this context */
1021
int nErr; /* Number of errors encountered while resolving names */
1022
u8 allowAgg; /* Aggregate functions allowed here */
1024
int nDepth; /* Depth of subquery recursion. 1 for no recursion */
1025
NameContext *pNext; /* Next outer name context. NULL for outermost */
1029
** An instance of the following structure contains all information
1030
** needed to generate code for a single SELECT statement.
1032
** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0.
1033
** If there is a LIMIT clause, the parser sets nLimit to the value of the
1034
** limit and nOffset to the value of the offset (or 0 if there is not
1035
** offset). But later on, nLimit and nOffset become the memory locations
1036
** in the VDBE that record the limit and offset counters.
1039
ExprList *pEList; /* The fields of the result */
1040
u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
1041
u8 isDistinct; /* True if the DISTINCT keyword is present */
1042
SrcList *pSrc; /* The FROM clause */
1043
Expr *pWhere; /* The WHERE clause */
1044
ExprList *pGroupBy; /* The GROUP BY clause */
1045
Expr *pHaving; /* The HAVING clause */
1046
ExprList *pOrderBy; /* The ORDER BY clause */
1047
Select *pPrior; /* Prior select in a compound select statement */
1048
Expr *pLimit; /* LIMIT expression. NULL means not used. */
1049
Expr *pOffset; /* OFFSET expression. NULL means not used. */
1050
int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */
1051
IdList **ppOpenTemp; /* OP_OpenTemp addresses used by multi-selects */
1052
Fetch *pFetch; /* If this stmt is part of a FETCH command */
1053
u8 isResolved; /* True once sqlite3SelectResolve() has run. */
1054
u8 isAgg; /* True if this is an aggregate query */
1058
** The results of a select can be distributed in several ways.
1060
#define SRT_Callback 1 /* Invoke a callback with each row of result */
1061
#define SRT_Mem 2 /* Store result in a memory cell */
1062
#define SRT_Set 3 /* Store result as unique keys in a table */
1063
#define SRT_Union 5 /* Store result as keys in a table */
1064
#define SRT_Except 6 /* Remove result from a UNION table */
1065
#define SRT_Table 7 /* Store result as data with a unique key */
1066
#define SRT_TempTable 8 /* Store result in a trasient table */
1067
#define SRT_Discard 9 /* Do not save the results anywhere */
1068
#define SRT_Sorter 10 /* Store results in the sorter */
1069
#define SRT_Subroutine 11 /* Call a subroutine to handle results */
1070
#define SRT_Exists 12 /* Put 0 or 1 in a memory cell */
1073
** When a SELECT uses aggregate functions (like "count(*)" or "avg(f1)")
1074
** we have to do some additional analysis of expressions. An instance
1075
** of the following structure holds information about a single subexpression
1076
** somewhere in the SELECT statement. An array of these structures holds
1077
** all the information we need to generate code for aggregate
1080
** Note that when analyzing a SELECT containing aggregates, both
1081
** non-aggregate field variables and aggregate functions are stored
1082
** in the AggExpr array of the Parser structure.
1084
** The pExpr field points to an expression that is part of either the
1085
** field list, the GROUP BY clause, the HAVING clause or the ORDER BY
1086
** clause. The expression will be freed when those clauses are cleaned
1087
** up. Do not try to delete the expression attached to AggExpr.pExpr.
1089
** If AggExpr.pExpr==0, that means the expression is "count(*)".
1092
int isAgg; /* if TRUE contains an aggregate function */
1093
Expr *pExpr; /* The expression */
1094
FuncDef *pFunc; /* Information about the aggregate function */
1098
** An SQL parser context. A copy of this structure is passed through
1099
** the parser and down into all the parser action routine in order to
1100
** carry around information that is global to the entire parse.
1102
** The structure is divided into two parts. When the parser and code
1103
** generate call themselves recursively, the first part of the structure
1104
** is constant but the second part is reset at the beginning and end of
1108
sqlite3 *db; /* The main database structure */
1109
int rc; /* Return code from execution */
1110
char *zErrMsg; /* An error message */
1111
Vdbe *pVdbe; /* An engine for executing database bytecode */
1112
u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */
1113
u8 nameClash; /* A permanent table name clashes with temp table name */
1114
u8 checkSchema; /* Causes schema cookie check after an error */
1115
u8 nested; /* Number of nested calls to the parser/code generator */
1116
int nErr; /* Number of errors seen */
1117
int nTab; /* Number of previously allocated VDBE cursors */
1118
int nMem; /* Number of memory cells used so far */
1119
int nSet; /* Number of sets used so far */
1120
u32 cookieMask; /* Bitmask of schema verified databases */
1121
int cookieValue[MAX_ATTACHED+2]; /* Values of cookies to verify */
1122
int cookieGoto; /* Address of OP_Goto to cookie verifier subroutine */
1123
u32 writeMask; /* Start a write transaction on these databases */
1124
u8 fillAgg; /* If true, ignore the Expr.iAgg field. Normally false */
1126
/* Above is constant between recursions. Below is reset before and after
1127
** each recursion */
1129
int nVar; /* Number of '?' variables seen in the SQL so far */
1130
int nVarExpr; /* Number of used slots in apVarExpr[] */
1131
int nVarExprAlloc; /* Number of allocated slots in apVarExpr[] */
1132
Expr **apVarExpr; /* Pointers to :aaa and $aaaa wildcard expressions */
1133
u8 explain; /* True if the EXPLAIN flag is found on the query */
1134
Token sErrToken; /* The token at which the error occurred */
1135
Token sNameToken; /* Token with unqualified schema object name */
1136
Token sLastToken; /* The last token parsed */
1137
const char *zSql; /* All SQL text */
1138
const char *zTail; /* All SQL text past the last semicolon parsed */
1139
Table *pNewTable; /* A table being constructed by CREATE TABLE */
1140
Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */
1141
TriggerStack *trigStack; /* Trigger actions being coded */
1142
const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
1143
int nAgg; /* Number of aggregate expressions */
1144
AggExpr *aAgg; /* An array of aggregate expressions */
1145
int nMaxDepth; /* Maximum depth of subquery recursion */
1149
** An instance of the following structure can be declared on a stack and used
1150
** to save the Parse.zAuthContext value so that it can be restored later.
1152
struct AuthContext {
1153
const char *zAuthContext; /* Put saved Parse.zAuthContext here */
1154
Parse *pParse; /* The Parse structure */
1158
** Bitfield flags for P2 value in OP_PutIntKey and OP_Delete
1160
#define OPFLAG_NCHANGE 1 /* Set to update db->nChange */
1161
#define OPFLAG_LASTROWID 2 /* Set to update db->lastRowid */
1164
* Each trigger present in the database schema is stored as an instance of
1167
* Pointers to instances of struct Trigger are stored in two ways.
1168
* 1. In the "trigHash" hash table (part of the sqlite3* that represents the
1169
* database). This allows Trigger structures to be retrieved by name.
1170
* 2. All triggers associated with a single table form a linked list, using the
1171
* pNext member of struct Trigger. A pointer to the first element of the
1172
* linked list is stored as the "pTrigger" member of the associated
1175
* The "step_list" member points to the first element of a linked list
1176
* containing the SQL statements specified as the trigger program.
1179
char *name; /* The name of the trigger */
1180
char *table; /* The table or view to which the trigger applies */
1181
u8 iDb; /* Database containing this trigger */
1182
u8 iTabDb; /* Database containing Trigger.table */
1183
u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */
1184
u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
1185
Expr *pWhen; /* The WHEN clause of the expresion (may be NULL) */
1186
IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger,
1187
the <column-list> is stored here */
1188
int foreach; /* One of TK_ROW or TK_STATEMENT */
1189
Token nameToken; /* Token containing zName. Use during parsing only */
1191
TriggerStep *step_list; /* Link list of trigger program steps */
1192
Trigger *pNext; /* Next trigger associated with the table */
1196
** A trigger is either a BEFORE or an AFTER trigger. The following constants
1199
** If there are multiple triggers, you might of some BEFORE and some AFTER.
1200
** In that cases, the constants below can be ORed together.
1202
#define TRIGGER_BEFORE 1
1203
#define TRIGGER_AFTER 2
1206
* An instance of struct TriggerStep is used to store a single SQL statement
1207
* that is a part of a trigger-program.
1209
* Instances of struct TriggerStep are stored in a singly linked list (linked
1210
* using the "pNext" member) referenced by the "step_list" member of the
1211
* associated struct Trigger instance. The first element of the linked list is
1212
* the first step of the trigger-program.
1214
* The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
1215
* "SELECT" statement. The meanings of the other members is determined by the
1216
* value of "op" as follows:
1219
* orconf -> stores the ON CONFLICT algorithm
1220
* pSelect -> If this is an INSERT INTO ... SELECT ... statement, then
1221
* this stores a pointer to the SELECT statement. Otherwise NULL.
1222
* target -> A token holding the name of the table to insert into.
1223
* pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
1224
* this stores values to be inserted. Otherwise NULL.
1225
* pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ...
1226
* statement, then this stores the column-names to be
1230
* target -> A token holding the name of the table to delete from.
1231
* pWhere -> The WHERE clause of the DELETE statement if one is specified.
1235
* target -> A token holding the name of the table to update rows of.
1236
* pWhere -> The WHERE clause of the UPDATE statement if one is specified.
1238
* pExprList -> A list of the columns to update and the expressions to update
1239
* them to. See sqlite3Update() documentation of "pChanges"
1243
struct TriggerStep {
1244
int op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1245
int orconf; /* OE_Rollback etc. */
1246
Trigger *pTrig; /* The trigger that this step is a part of */
1248
Select *pSelect; /* Valid for SELECT and sometimes
1249
INSERT steps (when pExprList == 0) */
1250
Token target; /* Valid for DELETE, UPDATE, INSERT steps */
1251
Expr *pWhere; /* Valid for DELETE, UPDATE steps */
1252
ExprList *pExprList; /* Valid for UPDATE statements and sometimes
1253
INSERT steps (when pSelect == 0) */
1254
IdList *pIdList; /* Valid for INSERT statements only */
1256
TriggerStep * pNext; /* Next in the link-list */
1260
* An instance of struct TriggerStack stores information required during code
1261
* generation of a single trigger program. While the trigger program is being
1262
* coded, its associated TriggerStack instance is pointed to by the
1263
* "pTriggerStack" member of the Parse structure.
1265
* The pTab member points to the table that triggers are being coded on. The
1266
* newIdx member contains the index of the vdbe cursor that points at the temp
1267
* table that stores the new.* references. If new.* references are not valid
1268
* for the trigger being coded (for example an ON DELETE trigger), then newIdx
1269
* is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1271
* The ON CONFLICT policy to be used for the trigger program steps is stored
1272
* as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1273
* specified for individual triggers steps is used.
1275
* struct TriggerStack has a "pNext" member, to allow linked lists to be
1276
* constructed. When coding nested triggers (triggers fired by other triggers)
1277
* each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1278
* pointer. Once the nested trigger has been coded, the pNext value is restored
1279
* to the pTriggerStack member of the Parse stucture and coding of the parent
1280
* trigger continues.
1282
* Before a nested trigger is coded, the linked list pointed to by the
1283
* pTriggerStack is scanned to ensure that the trigger is not about to be coded
1284
* recursively. If this condition is detected, the nested trigger is not coded.
1286
struct TriggerStack {
1287
Table *pTab; /* Table that triggers are currently being coded on */
1288
int newIdx; /* Index of vdbe cursor to "new" temp table */
1289
int oldIdx; /* Index of vdbe cursor to "old" temp table */
1290
int orconf; /* Current orconf policy */
1291
int ignoreJump; /* where to jump to for a RAISE(IGNORE) */
1292
Trigger *pTrigger; /* The trigger currently being coded */
1293
TriggerStack *pNext; /* Next trigger down on the trigger stack */
1297
** The following structure contains information used by the sqliteFix...
1298
** routines as they walk the parse tree to make database references
1301
typedef struct DbFixer DbFixer;
1303
Parse *pParse; /* The parsing context. Error messages written here */
1304
const char *zDb; /* Make sure all objects are contained in this database */
1305
const char *zType; /* Type of the container - used for error messages */
1306
const Token *pName; /* Name of the container - used for error messages */
1310
** A pointer to this structure is used to communicate information
1311
** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
1314
sqlite3 *db; /* The database being initialized */
1315
char **pzErrMsg; /* Error message stored here */
1319
* This global flag is set for performance testing of triggers. When it is set
1320
* SQLite will perform the overhead of building new and old trigger references
1321
* even when no triggers exist
1323
extern int sqlite3_always_code_trigger_setup;
1326
** Internal function prototypes
1328
int sqlite3StrICmp(const char *, const char *);
1329
int sqlite3StrNICmp(const char *, const char *, int);
1330
int sqlite3HashNoCase(const char *, int);
1331
int sqlite3IsNumber(const char*, int*, u8);
1332
int sqlite3Compare(const char *, const char *);
1333
int sqlite3SortCompare(const char *, const char *);
1334
void sqlite3RealToSortable(double r, char *);
1335
#ifdef SQLITE_MEMDEBUG
1336
void *sqlite3Malloc_(int,int,char*,int);
1337
void sqlite3Free_(void*,char*,int);
1338
void *sqlite3Realloc_(void*,int,char*,int);
1339
char *sqlite3StrDup_(const char*,char*,int);
1340
char *sqlite3StrNDup_(const char*, int,char*,int);
1341
void sqlite3CheckMemory(void*,int);
1343
void *sqlite3Malloc(int);
1344
void *sqlite3MallocRaw(int);
1345
void sqlite3Free(void*);
1346
void *sqlite3Realloc(void*,int);
1347
char *sqlite3StrDup(const char*);
1348
char *sqlite3StrNDup(const char*, int);
1349
# define sqlite3CheckMemory(a,b)
1351
void sqlite3FreeX(void*);
1352
char *sqlite3MPrintf(const char*, ...);
1353
char *sqlite3VMPrintf(const char*, va_list);
1354
void sqlite3DebugPrintf(const char*, ...);
1355
void *sqlite3TextToPtr(const char*);
1356
void sqlite3SetString(char **, const char *, ...);
1357
void sqlite3ErrorMsg(Parse*, const char*, ...);
1358
void sqlite3Dequote(char*);
1359
int sqlite3KeywordCode(const char*, int);
1360
int sqlite3RunParser(Parse*, const char*, char **);
1361
void sqlite3FinishCoding(Parse*);
1362
Expr *sqlite3Expr(int, Expr*, Expr*, const Token*);
1363
Expr *sqlite3RegisterExpr(Parse*,Token*);
1364
Expr *sqlite3ExprAnd(Expr*, Expr*);
1365
void sqlite3ExprSpan(Expr*,Token*,Token*);
1366
Expr *sqlite3ExprFunction(ExprList*, Token*);
1367
void sqlite3ExprAssignVarNumber(Parse*, Expr*);
1368
void sqlite3ExprDelete(Expr*);
1369
ExprList *sqlite3ExprListAppend(ExprList*,Expr*,Token*);
1370
void sqlite3ExprListDelete(ExprList*);
1371
int sqlite3Init(sqlite3*, char**);
1372
int sqlite3InitCallback(void*, int, char**, char**);
1373
void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
1374
void sqlite3ResetInternalSchema(sqlite3*, int);
1375
void sqlite3BeginParse(Parse*,int);
1376
void sqlite3RollbackInternalChanges(sqlite3*);
1377
void sqlite3CommitInternalChanges(sqlite3*);
1378
Table *sqlite3ResultSetOfSelect(Parse*,char*,Select*);
1379
void sqlite3OpenMasterTable(Vdbe *v, int);
1380
void sqlite3StartTable(Parse*,Token*,Token*,Token*,int,int);
1381
void sqlite3AddColumn(Parse*,Token*);
1382
void sqlite3AddNotNull(Parse*, int);
1383
void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int);
1384
void sqlite3AddColumnType(Parse*,Token*,Token*);
1385
void sqlite3AddDefaultValue(Parse*,Expr*);
1386
void sqlite3AddCollateType(Parse*, const char*, int);
1387
void sqlite3EndTable(Parse*,Token*,Token*,Select*);
1389
#ifndef SQLITE_OMIT_VIEW
1390
void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int);
1391
int sqlite3ViewGetColumnNames(Parse*,Table*);
1393
# define sqlite3ViewGetColumnNames(A,B) 0
1396
void sqlite3DropTable(Parse*, SrcList*, int);
1397
void sqlite3DeleteTable(sqlite3*, Table*);
1398
void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
1399
IdList *sqlite3IdListAppend(IdList*, Token*);
1400
int sqlite3IdListIndex(IdList*,const char*);
1401
SrcList *sqlite3SrcListAppend(SrcList*, Token*, Token*);
1402
void sqlite3SrcListAddAlias(SrcList*, Token*);
1403
void sqlite3SrcListAssignCursors(Parse*, SrcList*);
1404
void sqlite3IdListDelete(IdList*);
1405
void sqlite3SrcListDelete(SrcList*);
1406
void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
1408
void sqlite3DropIndex(Parse*, SrcList*);
1409
void sqlite3AddKeyType(Vdbe*, ExprList*);
1410
void sqlite3AddIdxKeyType(Vdbe*, Index*);
1411
int sqlite3Select(Parse*, Select*, int, int, Select*, int, int*, char *aff);
1412
Select *sqlite3SelectNew(ExprList*,SrcList*,Expr*,ExprList*,Expr*,ExprList*,
1414
void sqlite3SelectDelete(Select*);
1415
void sqlite3SelectUnbind(Select*);
1416
Table *sqlite3SrcListLookup(Parse*, SrcList*);
1417
int sqlite3IsReadOnly(Parse*, Table*, int);
1418
void sqlite3OpenTableForReading(Vdbe*, int iCur, Table*);
1419
void sqlite3OpenTable(Vdbe*, int iCur, Table*, int);
1420
void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
1421
void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
1422
WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**, Fetch*);
1423
void sqlite3WhereEnd(WhereInfo*);
1424
void sqlite3ExprCode(Parse*, Expr*);
1425
void sqlite3ExprCodeAndCache(Parse*, Expr*);
1426
int sqlite3ExprCodeExprList(Parse*, ExprList*);
1427
void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
1428
void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
1429
void sqlite3NextedParse(Parse*, const char*, ...);
1430
Table *sqlite3FindTable(sqlite3*,const char*, const char*);
1431
Table *sqlite3LocateTable(Parse*,const char*, const char*);
1432
Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
1433
void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
1434
void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
1435
void sqlite3Vacuum(Parse*, Token*);
1436
int sqlite3RunVacuum(char**, sqlite3*);
1437
char *sqlite3NameFromToken(Token*);
1438
int sqlite3ExprCheck(Parse*, Expr*, int, int*);
1439
int sqlite3ExprCompare(Expr*, Expr*);
1440
int sqliteFuncId(Token*);
1441
int sqlite3ExprResolveNames(NameContext *, Expr *);
1442
int sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
1443
Vdbe *sqlite3GetVdbe(Parse*);
1444
void sqlite3Randomness(int, void*);
1445
void sqlite3RollbackAll(sqlite3*);
1446
void sqlite3CodeVerifySchema(Parse*, int);
1447
void sqlite3BeginTransaction(Parse*, int);
1448
void sqlite3CommitTransaction(Parse*);
1449
void sqlite3RollbackTransaction(Parse*);
1450
int sqlite3ExprIsConstant(Expr*);
1451
int sqlite3ExprIsInteger(Expr*, int*);
1452
int sqlite3IsRowid(const char*);
1453
void sqlite3GenerateRowDelete(sqlite3*, Vdbe*, Table*, int, int);
1454
void sqlite3GenerateRowIndexDelete(sqlite3*, Vdbe*, Table*, int, char*);
1455
void sqlite3GenerateIndexKey(Vdbe*, Index*, int);
1456
void sqlite3GenerateConstraintChecks(Parse*,Table*,int,char*,int,int,int,int);
1457
void sqlite3CompleteInsertion(Parse*, Table*, int, char*, int, int, int);
1458
void sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
1459
void sqlite3BeginWriteOperation(Parse*, int, int);
1460
Expr *sqlite3ExprDup(Expr*);
1461
void sqlite3TokenCopy(Token*, Token*);
1462
ExprList *sqlite3ExprListDup(ExprList*);
1463
SrcList *sqlite3SrcListDup(SrcList*);
1464
IdList *sqlite3IdListDup(IdList*);
1465
Select *sqlite3SelectDup(Select*);
1466
FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
1467
void sqlite3RegisterBuiltinFunctions(sqlite3*);
1468
void sqlite3RegisterDateTimeFunctions(sqlite3*);
1469
int sqlite3SafetyOn(sqlite3*);
1470
int sqlite3SafetyOff(sqlite3*);
1471
int sqlite3SafetyCheck(sqlite3*);
1472
void sqlite3ChangeCookie(sqlite3*, Vdbe*, int);
1474
#ifndef SQLITE_OMIT_TRIGGER
1475
void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
1477
void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
1478
void sqlite3DropTrigger(Parse*, SrcList*);
1479
void sqlite3DropTriggerPtr(Parse*, Trigger*, int);
1480
int sqlite3TriggersExist(Parse*, Table*, int, ExprList*);
1481
int sqlite3CodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
1483
void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
1484
void sqlite3DeleteTriggerStep(TriggerStep*);
1485
TriggerStep *sqlite3TriggerSelectStep(Select*);
1486
TriggerStep *sqlite3TriggerInsertStep(Token*, IdList*, ExprList*,Select*,int);
1487
TriggerStep *sqlite3TriggerUpdateStep(Token*, ExprList*, Expr*, int);
1488
TriggerStep *sqlite3TriggerDeleteStep(Token*, Expr*);
1489
void sqlite3DeleteTrigger(Trigger*);
1490
void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
1492
# define sqlite3TriggersExist(A,B,C,D,E,F) 0
1493
# define sqlite3DeleteTrigger(A)
1494
# define sqlite3DropTriggerPtr(A,B,C)
1495
# define sqlite3UnlinkAndDeleteTrigger(A,B,C)
1496
# define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I) 0
1499
int sqlite3JoinType(Parse*, Token*, Token*, Token*);
1500
void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
1501
void sqlite3DeferForeignKey(Parse*, int);
1502
#ifndef SQLITE_OMIT_AUTHORIZATION
1503
void sqlite3AuthRead(Parse*,Expr*,SrcList*);
1504
int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
1505
void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
1506
void sqlite3AuthContextPop(AuthContext*);
1508
# define sqlite3AuthRead(a,b,c)
1509
# define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK
1510
# define sqlite3AuthContextPush(a,b,c)
1511
# define sqlite3AuthContextPop(a) ((void)(a))
1513
void sqlite3Attach(Parse*, Token*, Token*, int, Token*);
1514
void sqlite3Detach(Parse*, Token*);
1515
int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
1516
int omitJournal, int nCache, Btree **ppBtree);
1517
int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
1518
int sqlite3FixSrcList(DbFixer*, SrcList*);
1519
int sqlite3FixSelect(DbFixer*, Select*);
1520
int sqlite3FixExpr(DbFixer*, Expr*);
1521
int sqlite3FixExprList(DbFixer*, ExprList*);
1522
int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
1523
double sqlite3AtoF(const char *z, const char **);
1524
char *sqlite3_snprintf(int,char*,const char*,...);
1525
int sqlite3GetInt32(const char *, int*);
1526
int sqlite3FitsIn64Bits(const char *);
1527
int sqlite3utf16ByteLen(const void *pData, int nChar);
1528
int sqlite3utf8CharLen(const char *pData, int nByte);
1529
int sqlite3ReadUtf8(const unsigned char *);
1530
int sqlite3PutVarint(unsigned char *, u64);
1531
int sqlite3GetVarint(const unsigned char *, u64 *);
1532
int sqlite3GetVarint32(const unsigned char *, u32 *);
1533
int sqlite3VarintLen(u64 v);
1534
void sqlite3IndexAffinityStr(Vdbe *, Index *);
1535
void sqlite3TableAffinityStr(Vdbe *, Table *);
1536
char sqlite3CompareAffinity(Expr *pExpr, char aff2);
1537
int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
1538
char sqlite3ExprAffinity(Expr *pExpr);
1539
int sqlite3atoi64(const char*, i64*);
1540
void sqlite3Error(sqlite3*, int, const char*,...);
1541
void *sqlite3HexToBlob(const char *z);
1542
int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
1543
const char *sqlite3ErrStr(int);
1544
int sqlite3ReadUniChar(const char *zStr, int *pOffset, u8 *pEnc, int fold);
1545
int sqlite3ReadSchema(Parse *pParse);
1546
CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
1547
CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
1548
CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
1549
int sqlite3CheckCollSeq(Parse *, CollSeq *);
1550
int sqlite3CheckIndexCollSeq(Parse *, Index *);
1551
int sqlite3CheckObjectName(Parse *, const char *);
1552
void sqlite3VdbeSetChanges(sqlite3 *, int);
1553
void sqlite3utf16Substr(sqlite3_context *,int,sqlite3_value **);
1555
const void *sqlite3ValueText(sqlite3_value*, u8);
1556
int sqlite3ValueBytes(sqlite3_value*, u8);
1557
void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8, void(*)(void*));
1558
void sqlite3ValueFree(sqlite3_value*);
1559
sqlite3_value *sqlite3ValueNew();
1560
sqlite3_value *sqlite3GetTransientValue(sqlite3*db);
1561
int sqlite3ValueFromExpr(Expr *, u8, u8, sqlite3_value **);
1562
void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
1563
extern const unsigned char sqlite3UpperToLower[];
1564
void sqlite3RootPageMoved(Db*, int, int);
1565
void sqlite3Reindex(Parse*, Token*, Token*);
1566
void sqlite3AlterFunctions(sqlite3*);
1567
void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
1568
int sqlite3GetToken(const unsigned char *, int *);
1569
void sqlite3NestedParse(Parse*, const char*, ...);
1570
void sqlite3ExpirePreparedStatements(sqlite3*);
1571
void sqlite3CodeSubselect(Parse *, Expr *);
1572
int sqlite3SelectResolve(Parse *, Select *, NameContext *);
1573
void sqlite3ColumnDefault(Vdbe *, Table *, int);
1574
void sqlite3AlterFinishAddColumn(Parse *, Token *);
1575
void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
added
removed
src/3rdparty/sqlite/sqliteInt.h
