blob: 1cb6cb0d426621bdd439c03fb29f4ca2bbf99d54 [file] [log] [blame]
dan1da40a32009-09-19 17:00:31 +00001/*
2**
3** The author disclaims copyright to this source code. In place of
4** a legal notice, here is a blessing:
5**
6** May you do good and not evil.
7** May you find forgiveness for yourself and forgive others.
8** May you share freely, never taking more than you give.
9**
10*************************************************************************
11** This file contains code used by the compiler to add foreign key
12** support to compiled SQL statements.
13*/
14#include "sqliteInt.h"
15
16#ifndef SQLITE_OMIT_FOREIGN_KEY
dan75cbd982009-09-21 16:06:03 +000017#ifndef SQLITE_OMIT_TRIGGER
dan1da40a32009-09-19 17:00:31 +000018
19/*
20** Deferred and Immediate FKs
21** --------------------------
22**
23** Foreign keys in SQLite come in two flavours: deferred and immediate.
drhd91c1a12013-02-09 13:58:25 +000024** If an immediate foreign key constraint is violated,
25** SQLITE_CONSTRAINT_FOREIGNKEY is returned and the current
26** statement transaction rolled back. If a
dan1da40a32009-09-19 17:00:31 +000027** deferred foreign key constraint is violated, no action is taken
28** immediately. However if the application attempts to commit the
29** transaction before fixing the constraint violation, the attempt fails.
30**
31** Deferred constraints are implemented using a simple counter associated
32** with the database handle. The counter is set to zero each time a
33** database transaction is opened. Each time a statement is executed
34** that causes a foreign key violation, the counter is incremented. Each
35** time a statement is executed that removes an existing violation from
36** the database, the counter is decremented. When the transaction is
37** committed, the commit fails if the current value of the counter is
38** greater than zero. This scheme has two big drawbacks:
39**
40** * When a commit fails due to a deferred foreign key constraint,
41** there is no way to tell which foreign constraint is not satisfied,
42** or which row it is not satisfied for.
43**
44** * If the database contains foreign key violations when the
45** transaction is opened, this may cause the mechanism to malfunction.
46**
47** Despite these problems, this approach is adopted as it seems simpler
48** than the alternatives.
49**
50** INSERT operations:
51**
dan8099ce62009-09-23 08:43:35 +000052** I.1) For each FK for which the table is the child table, search
dan8a2fff72009-09-23 18:07:22 +000053** the parent table for a match. If none is found increment the
54** constraint counter.
dan1da40a32009-09-19 17:00:31 +000055**
dan8a2fff72009-09-23 18:07:22 +000056** I.2) For each FK for which the table is the parent table,
dan8099ce62009-09-23 08:43:35 +000057** search the child table for rows that correspond to the new
58** row in the parent table. Decrement the counter for each row
dan1da40a32009-09-19 17:00:31 +000059** found (as the constraint is now satisfied).
60**
61** DELETE operations:
62**
dan8a2fff72009-09-23 18:07:22 +000063** D.1) For each FK for which the table is the child table,
dan8099ce62009-09-23 08:43:35 +000064** search the parent table for a row that corresponds to the
65** deleted row in the child table. If such a row is not found,
dan1da40a32009-09-19 17:00:31 +000066** decrement the counter.
67**
dan8099ce62009-09-23 08:43:35 +000068** D.2) For each FK for which the table is the parent table, search
69** the child table for rows that correspond to the deleted row
dan8a2fff72009-09-23 18:07:22 +000070** in the parent table. For each found increment the counter.
dan1da40a32009-09-19 17:00:31 +000071**
72** UPDATE operations:
73**
74** An UPDATE command requires that all 4 steps above are taken, but only
75** for FK constraints for which the affected columns are actually
76** modified (values must be compared at runtime).
77**
78** Note that I.1 and D.1 are very similar operations, as are I.2 and D.2.
79** This simplifies the implementation a bit.
80**
81** For the purposes of immediate FK constraints, the OR REPLACE conflict
82** resolution is considered to delete rows before the new row is inserted.
83** If a delete caused by OR REPLACE violates an FK constraint, an exception
84** is thrown, even if the FK constraint would be satisfied after the new
85** row is inserted.
86**
danbd747832009-09-25 12:00:01 +000087** Immediate constraints are usually handled similarly. The only difference
88** is that the counter used is stored as part of each individual statement
89** object (struct Vdbe). If, after the statement has run, its immediate
drhd91c1a12013-02-09 13:58:25 +000090** constraint counter is greater than zero,
91** it returns SQLITE_CONSTRAINT_FOREIGNKEY
danbd747832009-09-25 12:00:01 +000092** and the statement transaction is rolled back. An exception is an INSERT
93** statement that inserts a single row only (no triggers). In this case,
94** instead of using a counter, an exception is thrown immediately if the
95** INSERT violates a foreign key constraint. This is necessary as such
96** an INSERT does not open a statement transaction.
97**
dan1da40a32009-09-19 17:00:31 +000098** TODO: How should dropping a table be handled? How should renaming a
99** table be handled?
dan8099ce62009-09-23 08:43:35 +0000100**
101**
dan1da40a32009-09-19 17:00:31 +0000102** Query API Notes
103** ---------------
104**
105** Before coding an UPDATE or DELETE row operation, the code-generator
106** for those two operations needs to know whether or not the operation
107** requires any FK processing and, if so, which columns of the original
108** row are required by the FK processing VDBE code (i.e. if FKs were
109** implemented using triggers, which of the old.* columns would be
110** accessed). No information is required by the code-generator before
dan8099ce62009-09-23 08:43:35 +0000111** coding an INSERT operation. The functions used by the UPDATE/DELETE
112** generation code to query for this information are:
dan1da40a32009-09-19 17:00:31 +0000113**
dan8099ce62009-09-23 08:43:35 +0000114** sqlite3FkRequired() - Test to see if FK processing is required.
115** sqlite3FkOldmask() - Query for the set of required old.* columns.
116**
117**
118** Externally accessible module functions
119** --------------------------------------
120**
121** sqlite3FkCheck() - Check for foreign key violations.
122** sqlite3FkActions() - Code triggers for ON UPDATE/ON DELETE actions.
123** sqlite3FkDelete() - Delete an FKey structure.
dan1da40a32009-09-19 17:00:31 +0000124*/
125
126/*
127** VDBE Calling Convention
128** -----------------------
129**
130** Example:
131**
132** For the following INSERT statement:
133**
134** CREATE TABLE t1(a, b INTEGER PRIMARY KEY, c);
135** INSERT INTO t1 VALUES(1, 2, 3.1);
136**
137** Register (x): 2 (type integer)
138** Register (x+1): 1 (type integer)
139** Register (x+2): NULL (type NULL)
140** Register (x+3): 3.1 (type real)
141*/
142
143/*
dan8099ce62009-09-23 08:43:35 +0000144** A foreign key constraint requires that the key columns in the parent
dan1da40a32009-09-19 17:00:31 +0000145** table are collectively subject to a UNIQUE or PRIMARY KEY constraint.
dan8099ce62009-09-23 08:43:35 +0000146** Given that pParent is the parent table for foreign key constraint pFKey,
drh6c5b9152012-12-17 16:46:37 +0000147** search the schema for a unique index on the parent key columns.
dan1da40a32009-09-19 17:00:31 +0000148**
dan8099ce62009-09-23 08:43:35 +0000149** If successful, zero is returned. If the parent key is an INTEGER PRIMARY
150** KEY column, then output variable *ppIdx is set to NULL. Otherwise, *ppIdx
151** is set to point to the unique index.
152**
153** If the parent key consists of a single column (the foreign key constraint
154** is not a composite foreign key), output variable *paiCol is set to NULL.
155** Otherwise, it is set to point to an allocated array of size N, where
156** N is the number of columns in the parent key. The first element of the
157** array is the index of the child table column that is mapped by the FK
158** constraint to the parent table column stored in the left-most column
159** of index *ppIdx. The second element of the array is the index of the
160** child table column that corresponds to the second left-most column of
161** *ppIdx, and so on.
162**
163** If the required index cannot be found, either because:
164**
165** 1) The named parent key columns do not exist, or
166**
167** 2) The named parent key columns do exist, but are not subject to a
168** UNIQUE or PRIMARY KEY constraint, or
169**
170** 3) No parent key columns were provided explicitly as part of the
171** foreign key definition, and the parent table does not have a
172** PRIMARY KEY, or
173**
174** 4) No parent key columns were provided explicitly as part of the
175** foreign key definition, and the PRIMARY KEY of the parent table
176** consists of a a different number of columns to the child key in
177** the child table.
178**
179** then non-zero is returned, and a "foreign key mismatch" error loaded
180** into pParse. If an OOM error occurs, non-zero is returned and the
181** pParse->db->mallocFailed flag is set.
dan1da40a32009-09-19 17:00:31 +0000182*/
drh6c5b9152012-12-17 16:46:37 +0000183int sqlite3FkLocateIndex(
dan1da40a32009-09-19 17:00:31 +0000184 Parse *pParse, /* Parse context to store any error in */
dan8099ce62009-09-23 08:43:35 +0000185 Table *pParent, /* Parent table of FK constraint pFKey */
dan1da40a32009-09-19 17:00:31 +0000186 FKey *pFKey, /* Foreign key to find index for */
dan8099ce62009-09-23 08:43:35 +0000187 Index **ppIdx, /* OUT: Unique index on parent table */
dan1da40a32009-09-19 17:00:31 +0000188 int **paiCol /* OUT: Map of index columns in pFKey */
189){
dan8099ce62009-09-23 08:43:35 +0000190 Index *pIdx = 0; /* Value to return via *ppIdx */
191 int *aiCol = 0; /* Value to return via *paiCol */
192 int nCol = pFKey->nCol; /* Number of columns in parent key */
193 char *zKey = pFKey->aCol[0].zCol; /* Name of left-most parent key column */
dan1da40a32009-09-19 17:00:31 +0000194
195 /* The caller is responsible for zeroing output parameters. */
196 assert( ppIdx && *ppIdx==0 );
197 assert( !paiCol || *paiCol==0 );
danf7a94542009-09-30 08:11:07 +0000198 assert( pParse );
dan1da40a32009-09-19 17:00:31 +0000199
200 /* If this is a non-composite (single column) foreign key, check if it
dan8099ce62009-09-23 08:43:35 +0000201 ** maps to the INTEGER PRIMARY KEY of table pParent. If so, leave *ppIdx
dan1da40a32009-09-19 17:00:31 +0000202 ** and *paiCol set to zero and return early.
203 **
204 ** Otherwise, for a composite foreign key (more than one column), allocate
205 ** space for the aiCol array (returned via output parameter *paiCol).
206 ** Non-composite foreign keys do not require the aiCol array.
207 */
208 if( nCol==1 ){
209 /* The FK maps to the IPK if any of the following are true:
210 **
dand981d442009-09-23 13:59:17 +0000211 ** 1) There is an INTEGER PRIMARY KEY column and the FK is implicitly
212 ** mapped to the primary key of table pParent, or
213 ** 2) The FK is explicitly mapped to a column declared as INTEGER
dan1da40a32009-09-19 17:00:31 +0000214 ** PRIMARY KEY.
215 */
dan8099ce62009-09-23 08:43:35 +0000216 if( pParent->iPKey>=0 ){
217 if( !zKey ) return 0;
218 if( !sqlite3StrICmp(pParent->aCol[pParent->iPKey].zName, zKey) ) return 0;
dan1da40a32009-09-19 17:00:31 +0000219 }
220 }else if( paiCol ){
221 assert( nCol>1 );
222 aiCol = (int *)sqlite3DbMallocRaw(pParse->db, nCol*sizeof(int));
223 if( !aiCol ) return 1;
224 *paiCol = aiCol;
225 }
226
dan8099ce62009-09-23 08:43:35 +0000227 for(pIdx=pParent->pIndex; pIdx; pIdx=pIdx->pNext){
drhbbbdc832013-10-22 18:01:40 +0000228 if( pIdx->nKeyCol==nCol && pIdx->onError!=OE_None ){
dan1da40a32009-09-19 17:00:31 +0000229 /* pIdx is a UNIQUE index (or a PRIMARY KEY) and has the right number
230 ** of columns. If each indexed column corresponds to a foreign key
231 ** column of pFKey, then this index is a winner. */
232
dan8099ce62009-09-23 08:43:35 +0000233 if( zKey==0 ){
234 /* If zKey is NULL, then this foreign key is implicitly mapped to
235 ** the PRIMARY KEY of table pParent. The PRIMARY KEY index may be
dan1da40a32009-09-19 17:00:31 +0000236 ** identified by the test (Index.autoIndex==2). */
237 if( pIdx->autoIndex==2 ){
dan8a2fff72009-09-23 18:07:22 +0000238 if( aiCol ){
239 int i;
240 for(i=0; i<nCol; i++) aiCol[i] = pFKey->aCol[i].iFrom;
241 }
dan1da40a32009-09-19 17:00:31 +0000242 break;
243 }
244 }else{
dan8099ce62009-09-23 08:43:35 +0000245 /* If zKey is non-NULL, then this foreign key was declared to
246 ** map to an explicit list of columns in table pParent. Check if this
dan9707c7b2009-09-29 15:41:57 +0000247 ** index matches those columns. Also, check that the index uses
248 ** the default collation sequences for each column. */
dan1da40a32009-09-19 17:00:31 +0000249 int i, j;
250 for(i=0; i<nCol; i++){
drhbbbdc832013-10-22 18:01:40 +0000251 i16 iCol = pIdx->aiColumn[i]; /* Index of column in parent tbl */
dan9707c7b2009-09-29 15:41:57 +0000252 char *zDfltColl; /* Def. collation for column */
253 char *zIdxCol; /* Name of indexed column */
254
255 /* If the index uses a collation sequence that is different from
256 ** the default collation sequence for the column, this index is
257 ** unusable. Bail out early in this case. */
258 zDfltColl = pParent->aCol[iCol].zColl;
259 if( !zDfltColl ){
260 zDfltColl = "BINARY";
261 }
262 if( sqlite3StrICmp(pIdx->azColl[i], zDfltColl) ) break;
263
264 zIdxCol = pParent->aCol[iCol].zName;
dan1da40a32009-09-19 17:00:31 +0000265 for(j=0; j<nCol; j++){
266 if( sqlite3StrICmp(pFKey->aCol[j].zCol, zIdxCol)==0 ){
267 if( aiCol ) aiCol[i] = pFKey->aCol[j].iFrom;
268 break;
269 }
270 }
271 if( j==nCol ) break;
272 }
273 if( i==nCol ) break; /* pIdx is usable */
274 }
275 }
276 }
277
danf7a94542009-09-30 08:11:07 +0000278 if( !pIdx ){
danf0662562009-09-28 18:52:11 +0000279 if( !pParse->disableTriggers ){
drh9148def2012-12-17 20:40:39 +0000280 sqlite3ErrorMsg(pParse,
281 "foreign key mismatch - \"%w\" referencing \"%w\"",
282 pFKey->pFrom->zName, pFKey->zTo);
danf0662562009-09-28 18:52:11 +0000283 }
dan1da40a32009-09-19 17:00:31 +0000284 sqlite3DbFree(pParse->db, aiCol);
285 return 1;
286 }
287
288 *ppIdx = pIdx;
289 return 0;
290}
291
dan8099ce62009-09-23 08:43:35 +0000292/*
danbd747832009-09-25 12:00:01 +0000293** This function is called when a row is inserted into or deleted from the
294** child table of foreign key constraint pFKey. If an SQL UPDATE is executed
295** on the child table of pFKey, this function is invoked twice for each row
dan8099ce62009-09-23 08:43:35 +0000296** affected - once to "delete" the old row, and then again to "insert" the
297** new row.
298**
299** Each time it is called, this function generates VDBE code to locate the
300** row in the parent table that corresponds to the row being inserted into
301** or deleted from the child table. If the parent row can be found, no
302** special action is taken. Otherwise, if the parent row can *not* be
303** found in the parent table:
304**
305** Operation | FK type | Action taken
306** --------------------------------------------------------------------------
danbd747832009-09-25 12:00:01 +0000307** INSERT immediate Increment the "immediate constraint counter".
308**
309** DELETE immediate Decrement the "immediate constraint counter".
dan8099ce62009-09-23 08:43:35 +0000310**
311** INSERT deferred Increment the "deferred constraint counter".
312**
313** DELETE deferred Decrement the "deferred constraint counter".
314**
danbd747832009-09-25 12:00:01 +0000315** These operations are identified in the comment at the top of this file
316** (fkey.c) as "I.1" and "D.1".
dan8099ce62009-09-23 08:43:35 +0000317*/
318static void fkLookupParent(
dan1da40a32009-09-19 17:00:31 +0000319 Parse *pParse, /* Parse context */
320 int iDb, /* Index of database housing pTab */
dan8099ce62009-09-23 08:43:35 +0000321 Table *pTab, /* Parent table of FK pFKey */
322 Index *pIdx, /* Unique index on parent key columns in pTab */
323 FKey *pFKey, /* Foreign key constraint */
324 int *aiCol, /* Map from parent key columns to child table columns */
325 int regData, /* Address of array containing child table row */
dan02470b22009-10-03 07:04:11 +0000326 int nIncr, /* Increment constraint counter by this */
327 int isIgnore /* If true, pretend pTab contains all NULL values */
dan1da40a32009-09-19 17:00:31 +0000328){
dan8099ce62009-09-23 08:43:35 +0000329 int i; /* Iterator variable */
330 Vdbe *v = sqlite3GetVdbe(pParse); /* Vdbe to add code to */
331 int iCur = pParse->nTab - 1; /* Cursor number to use */
332 int iOk = sqlite3VdbeMakeLabel(v); /* jump here if parent key found */
dan1da40a32009-09-19 17:00:31 +0000333
dan0ff297e2009-09-25 17:03:14 +0000334 /* If nIncr is less than zero, then check at runtime if there are any
335 ** outstanding constraints to resolve. If there are not, there is no need
336 ** to check if deleting this row resolves any outstanding violations.
337 **
338 ** Check if any of the key columns in the child table row are NULL. If
339 ** any are, then the constraint is considered satisfied. No need to
340 ** search for a matching row in the parent table. */
341 if( nIncr<0 ){
342 sqlite3VdbeAddOp2(v, OP_FkIfZero, pFKey->isDeferred, iOk);
343 }
dan1da40a32009-09-19 17:00:31 +0000344 for(i=0; i<pFKey->nCol; i++){
dan36062642009-09-21 18:56:23 +0000345 int iReg = aiCol[i] + regData + 1;
dan1da40a32009-09-19 17:00:31 +0000346 sqlite3VdbeAddOp2(v, OP_IsNull, iReg, iOk);
347 }
348
dan02470b22009-10-03 07:04:11 +0000349 if( isIgnore==0 ){
350 if( pIdx==0 ){
351 /* If pIdx is NULL, then the parent key is the INTEGER PRIMARY KEY
352 ** column of the parent table (table pTab). */
353 int iMustBeInt; /* Address of MustBeInt instruction */
354 int regTemp = sqlite3GetTempReg(pParse);
355
356 /* Invoke MustBeInt to coerce the child key value to an integer (i.e.
357 ** apply the affinity of the parent key). If this fails, then there
358 ** is no matching parent key. Before using MustBeInt, make a copy of
359 ** the value. Otherwise, the value inserted into the child key column
360 ** will have INTEGER affinity applied to it, which may not be correct. */
361 sqlite3VdbeAddOp2(v, OP_SCopy, aiCol[0]+1+regData, regTemp);
362 iMustBeInt = sqlite3VdbeAddOp2(v, OP_MustBeInt, regTemp, 0);
363
364 /* If the parent table is the same as the child table, and we are about
365 ** to increment the constraint-counter (i.e. this is an INSERT operation),
366 ** then check if the row being inserted matches itself. If so, do not
367 ** increment the constraint-counter. */
368 if( pTab==pFKey->pFrom && nIncr==1 ){
369 sqlite3VdbeAddOp3(v, OP_Eq, regData, iOk, regTemp);
dan9277efa2009-09-28 11:54:21 +0000370 }
dan02470b22009-10-03 07:04:11 +0000371
372 sqlite3OpenTable(pParse, iCur, iDb, pTab, OP_OpenRead);
373 sqlite3VdbeAddOp3(v, OP_NotExists, iCur, 0, regTemp);
dan9277efa2009-09-28 11:54:21 +0000374 sqlite3VdbeAddOp2(v, OP_Goto, 0, iOk);
dan02470b22009-10-03 07:04:11 +0000375 sqlite3VdbeJumpHere(v, sqlite3VdbeCurrentAddr(v)-2);
376 sqlite3VdbeJumpHere(v, iMustBeInt);
377 sqlite3ReleaseTempReg(pParse, regTemp);
378 }else{
379 int nCol = pFKey->nCol;
380 int regTemp = sqlite3GetTempRange(pParse, nCol);
381 int regRec = sqlite3GetTempReg(pParse);
dan02470b22009-10-03 07:04:11 +0000382
383 sqlite3VdbeAddOp3(v, OP_OpenRead, iCur, pIdx->tnum, iDb);
drh2ec2fb22013-11-06 19:59:23 +0000384 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
dan02470b22009-10-03 07:04:11 +0000385 for(i=0; i<nCol; i++){
drhebc16712010-09-28 00:25:58 +0000386 sqlite3VdbeAddOp2(v, OP_Copy, aiCol[i]+1+regData, regTemp+i);
dan02470b22009-10-03 07:04:11 +0000387 }
388
389 /* If the parent table is the same as the child table, and we are about
390 ** to increment the constraint-counter (i.e. this is an INSERT operation),
391 ** then check if the row being inserted matches itself. If so, do not
danb328deb2011-06-10 16:33:25 +0000392 ** increment the constraint-counter.
393 **
394 ** If any of the parent-key values are NULL, then the row cannot match
395 ** itself. So set JUMPIFNULL to make sure we do the OP_Found if any
396 ** of the parent-key values are NULL (at this point it is known that
397 ** none of the child key values are).
398 */
dan02470b22009-10-03 07:04:11 +0000399 if( pTab==pFKey->pFrom && nIncr==1 ){
400 int iJump = sqlite3VdbeCurrentAddr(v) + nCol + 1;
401 for(i=0; i<nCol; i++){
402 int iChild = aiCol[i]+1+regData;
403 int iParent = pIdx->aiColumn[i]+1+regData;
danb328deb2011-06-10 16:33:25 +0000404 assert( aiCol[i]!=pTab->iPKey );
405 if( pIdx->aiColumn[i]==pTab->iPKey ){
406 /* The parent key is a composite key that includes the IPK column */
407 iParent = regData;
408 }
dan02470b22009-10-03 07:04:11 +0000409 sqlite3VdbeAddOp3(v, OP_Ne, iChild, iJump, iParent);
danb328deb2011-06-10 16:33:25 +0000410 sqlite3VdbeChangeP5(v, SQLITE_JUMPIFNULL);
dan02470b22009-10-03 07:04:11 +0000411 }
412 sqlite3VdbeAddOp2(v, OP_Goto, 0, iOk);
413 }
414
415 sqlite3VdbeAddOp3(v, OP_MakeRecord, regTemp, nCol, regRec);
drh8d129422011-04-05 12:25:19 +0000416 sqlite3VdbeChangeP4(v, -1, sqlite3IndexAffinityStr(v,pIdx), P4_TRANSIENT);
drh8cff69d2009-11-12 19:59:44 +0000417 sqlite3VdbeAddOp4Int(v, OP_Found, iCur, iOk, regRec, 0);
dan02470b22009-10-03 07:04:11 +0000418
419 sqlite3ReleaseTempReg(pParse, regRec);
420 sqlite3ReleaseTempRange(pParse, regTemp, nCol);
dan9277efa2009-09-28 11:54:21 +0000421 }
dan1da40a32009-09-19 17:00:31 +0000422 }
423
drh648e2642013-07-11 15:03:32 +0000424 if( !pFKey->isDeferred && !(pParse->db->flags & SQLITE_DeferFKs)
425 && !pParse->pToplevel
426 && !pParse->isMultiWrite
427 ){
dan32b09f22009-09-23 17:29:59 +0000428 /* Special case: If this is an INSERT statement that will insert exactly
429 ** one row into the table, raise a constraint immediately instead of
430 ** incrementing a counter. This is necessary as the VM code is being
431 ** generated for will not open a statement transaction. */
432 assert( nIncr==1 );
drhd91c1a12013-02-09 13:58:25 +0000433 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_FOREIGNKEY,
drhf9c8ce32013-11-05 13:33:55 +0000434 OE_Abort, 0, P4_STATIC, P5_ConstraintFK);
dan32b09f22009-09-23 17:29:59 +0000435 }else{
436 if( nIncr>0 && pFKey->isDeferred==0 ){
437 sqlite3ParseToplevel(pParse)->mayAbort = 1;
438 }
dan0ff297e2009-09-25 17:03:14 +0000439 sqlite3VdbeAddOp2(v, OP_FkCounter, pFKey->isDeferred, nIncr);
dan1da40a32009-09-19 17:00:31 +0000440 }
441
442 sqlite3VdbeResolveLabel(v, iOk);
daned81bf62009-10-07 16:04:46 +0000443 sqlite3VdbeAddOp1(v, OP_Close, iCur);
dan1da40a32009-09-19 17:00:31 +0000444}
445
drh90e758f2013-11-04 13:56:00 +0000446
447/*
448** Return an Expr object that refers to a memory register corresponding
449** to column iCol of table pTab.
450**
451** regBase is the first of an array of register that contains the data
452** for pTab. regBase itself holds the rowid. regBase+1 holds the first
453** column. regBase+2 holds the second column, and so forth.
454*/
455static Expr *exprTableRegister(
456 Parse *pParse, /* Parsing and code generating context */
457 Table *pTab, /* The table whose content is at r[regBase]... */
458 int regBase, /* Contents of table pTab */
459 i16 iCol /* Which column of pTab is desired */
460){
461 Expr *pExpr;
462 Column *pCol;
463 const char *zColl;
464 sqlite3 *db = pParse->db;
465
466 pExpr = sqlite3Expr(db, TK_REGISTER, 0);
467 if( pExpr ){
468 if( iCol>=0 && iCol!=pTab->iPKey ){
469 pCol = &pTab->aCol[iCol];
470 pExpr->iTable = regBase + iCol + 1;
471 pExpr->affinity = pCol->affinity;
472 zColl = pCol->zColl;
473 if( zColl==0 ) zColl = db->pDfltColl->zName;
474 pExpr = sqlite3ExprAddCollateString(pParse, pExpr, zColl);
475 }else{
476 pExpr->iTable = regBase;
477 pExpr->affinity = SQLITE_AFF_INTEGER;
478 }
479 }
480 return pExpr;
481}
482
483/*
484** Return an Expr object that refers to column iCol of table pTab which
485** has cursor iCur.
486*/
487static Expr *exprTableColumn(
488 sqlite3 *db, /* The database connection */
489 Table *pTab, /* The table whose column is desired */
490 int iCursor, /* The open cursor on the table */
491 i16 iCol /* The column that is wanted */
492){
493 Expr *pExpr = sqlite3Expr(db, TK_COLUMN, 0);
494 if( pExpr ){
495 pExpr->pTab = pTab;
496 pExpr->iTable = iCursor;
497 pExpr->iColumn = iCol;
498 }
499 return pExpr;
500}
501
dan8099ce62009-09-23 08:43:35 +0000502/*
503** This function is called to generate code executed when a row is deleted
504** from the parent table of foreign key constraint pFKey and, if pFKey is
505** deferred, when a row is inserted into the same table. When generating
506** code for an SQL UPDATE operation, this function may be called twice -
507** once to "delete" the old row and once to "insert" the new row.
508**
509** The code generated by this function scans through the rows in the child
510** table that correspond to the parent table row being deleted or inserted.
511** For each child row found, one of the following actions is taken:
512**
513** Operation | FK type | Action taken
514** --------------------------------------------------------------------------
danbd747832009-09-25 12:00:01 +0000515** DELETE immediate Increment the "immediate constraint counter".
516** Or, if the ON (UPDATE|DELETE) action is RESTRICT,
drhf9c8ce32013-11-05 13:33:55 +0000517** throw a "FOREIGN KEY constraint failed" exception.
danbd747832009-09-25 12:00:01 +0000518**
519** INSERT immediate Decrement the "immediate constraint counter".
dan8099ce62009-09-23 08:43:35 +0000520**
521** DELETE deferred Increment the "deferred constraint counter".
522** Or, if the ON (UPDATE|DELETE) action is RESTRICT,
drhf9c8ce32013-11-05 13:33:55 +0000523** throw a "FOREIGN KEY constraint failed" exception.
dan8099ce62009-09-23 08:43:35 +0000524**
525** INSERT deferred Decrement the "deferred constraint counter".
526**
danbd747832009-09-25 12:00:01 +0000527** These operations are identified in the comment at the top of this file
528** (fkey.c) as "I.2" and "D.2".
dan8099ce62009-09-23 08:43:35 +0000529*/
530static void fkScanChildren(
dan1da40a32009-09-19 17:00:31 +0000531 Parse *pParse, /* Parse context */
drhbd50a922013-11-03 02:27:58 +0000532 SrcList *pSrc, /* The child table to be scanned */
533 Table *pTab, /* The parent table */
534 Index *pIdx, /* Index on parent covering the foreign key */
535 FKey *pFKey, /* The foreign key linking pSrc to pTab */
dan8099ce62009-09-23 08:43:35 +0000536 int *aiCol, /* Map from pIdx cols to child table cols */
drhbd50a922013-11-03 02:27:58 +0000537 int regData, /* Parent row data starts here */
dan1da40a32009-09-19 17:00:31 +0000538 int nIncr /* Amount to increment deferred counter by */
539){
540 sqlite3 *db = pParse->db; /* Database handle */
541 int i; /* Iterator variable */
542 Expr *pWhere = 0; /* WHERE clause to scan with */
543 NameContext sNameContext; /* Context used to resolve WHERE clause */
544 WhereInfo *pWInfo; /* Context used by sqlite3WhereXXX() */
dan0ff297e2009-09-25 17:03:14 +0000545 int iFkIfZero = 0; /* Address of OP_FkIfZero */
546 Vdbe *v = sqlite3GetVdbe(pParse);
547
drhbd50a922013-11-03 02:27:58 +0000548 assert( pIdx==0 || pIdx->pTable==pTab );
549 assert( pIdx==0 || pIdx->nKeyCol==pFKey->nCol );
550 assert( pIdx!=0 || pFKey->nCol==1 );
dan9277efa2009-09-28 11:54:21 +0000551
dan0ff297e2009-09-25 17:03:14 +0000552 if( nIncr<0 ){
553 iFkIfZero = sqlite3VdbeAddOp2(v, OP_FkIfZero, pFKey->isDeferred, 0);
554 }
dan1da40a32009-09-19 17:00:31 +0000555
danbd747832009-09-25 12:00:01 +0000556 /* Create an Expr object representing an SQL expression like:
557 **
558 ** <parent-key1> = <child-key1> AND <parent-key2> = <child-key2> ...
559 **
560 ** The collation sequence used for the comparison should be that of
561 ** the parent key columns. The affinity of the parent key column should
562 ** be applied to each child key value before the comparison takes place.
563 */
dan1da40a32009-09-19 17:00:31 +0000564 for(i=0; i<pFKey->nCol; i++){
dan8099ce62009-09-23 08:43:35 +0000565 Expr *pLeft; /* Value from parent table row */
566 Expr *pRight; /* Column ref to child table */
dan1da40a32009-09-19 17:00:31 +0000567 Expr *pEq; /* Expression (pLeft = pRight) */
drhbbbdc832013-10-22 18:01:40 +0000568 i16 iCol; /* Index of column in child table */
dan8099ce62009-09-23 08:43:35 +0000569 const char *zCol; /* Name of column in child table */
dan1da40a32009-09-19 17:00:31 +0000570
drh90e758f2013-11-04 13:56:00 +0000571 iCol = pIdx ? pIdx->aiColumn[i] : -1;
572 pLeft = exprTableRegister(pParse, pTab, regData, iCol);
dan1da40a32009-09-19 17:00:31 +0000573 iCol = aiCol ? aiCol[i] : pFKey->aCol[0].iFrom;
dana8f0bf62009-09-23 12:06:52 +0000574 assert( iCol>=0 );
575 zCol = pFKey->pFrom->aCol[iCol].zName;
dan1da40a32009-09-19 17:00:31 +0000576 pRight = sqlite3Expr(db, TK_ID, zCol);
577 pEq = sqlite3PExpr(pParse, TK_EQ, pLeft, pRight, 0);
578 pWhere = sqlite3ExprAnd(db, pWhere, pEq);
579 }
580
drh90e758f2013-11-04 13:56:00 +0000581 /* If the child table is the same as the parent table, then add terms
582 ** to the WHERE clause that prevent this entry from being scanned.
583 ** The added WHERE clause terms are like this:
584 **
585 ** $current_rowid!=rowid
586 ** NOT( $current_a==a AND $current_b==b AND ... )
587 **
588 ** The first form is used for rowid tables. The second form is used
589 ** for WITHOUT ROWID tables. In the second form, the primary key is
590 ** (a,b,...)
591 */
592 if( pTab==pFKey->pFrom && nIncr>0 ){
drhbd50a922013-11-03 02:27:58 +0000593 Expr *pNe; /* Expression (pLeft != pRight) */
dan9277efa2009-09-28 11:54:21 +0000594 Expr *pLeft; /* Value from parent table row */
595 Expr *pRight; /* Column ref to child table */
drh90e758f2013-11-04 13:56:00 +0000596 if( HasRowid(pTab) ){
597 pLeft = exprTableRegister(pParse, pTab, regData, -1);
598 pRight = exprTableColumn(db, pTab, pSrc->a[0].iCursor, -1);
599 pNe = sqlite3PExpr(pParse, TK_NE, pLeft, pRight, 0);
600 }else{
drh90e758f2013-11-04 13:56:00 +0000601 Expr *pEq, *pAll = 0;
602 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
603 for(i=0; i<pPk->nKeyCol; i++){
604 i16 iCol = pIdx->aiColumn[i];
605 pLeft = exprTableRegister(pParse, pTab, regData, iCol);
606 pRight = exprTableColumn(db, pTab, pSrc->a[0].iCursor, iCol);
607 pEq = sqlite3PExpr(pParse, TK_EQ, pLeft, pRight, 0);
608 pAll = sqlite3ExprAnd(db, pAll, pEq);
609 }
610 pNe = sqlite3PExpr(pParse, TK_NOT, pAll, 0, 0);
dan9277efa2009-09-28 11:54:21 +0000611 }
drhbd50a922013-11-03 02:27:58 +0000612 pWhere = sqlite3ExprAnd(db, pWhere, pNe);
dan9277efa2009-09-28 11:54:21 +0000613 }
614
dan1da40a32009-09-19 17:00:31 +0000615 /* Resolve the references in the WHERE clause. */
616 memset(&sNameContext, 0, sizeof(NameContext));
617 sNameContext.pSrcList = pSrc;
618 sNameContext.pParse = pParse;
619 sqlite3ResolveExprNames(&sNameContext, pWhere);
620
621 /* Create VDBE to loop through the entries in pSrc that match the WHERE
622 ** clause. If the constraint is not deferred, throw an exception for
623 ** each row found. Otherwise, for deferred constraints, increment the
624 ** deferred constraint counter by nIncr for each row selected. */
dan0efb72c2012-08-24 18:44:56 +0000625 pWInfo = sqlite3WhereBegin(pParse, pSrc, pWhere, 0, 0, 0, 0);
danf7a94542009-09-30 08:11:07 +0000626 if( nIncr>0 && pFKey->isDeferred==0 ){
627 sqlite3ParseToplevel(pParse)->mayAbort = 1;
dan1da40a32009-09-19 17:00:31 +0000628 }
danf7a94542009-09-30 08:11:07 +0000629 sqlite3VdbeAddOp2(v, OP_FkCounter, pFKey->isDeferred, nIncr);
danf59c5ca2009-09-22 16:55:38 +0000630 if( pWInfo ){
631 sqlite3WhereEnd(pWInfo);
632 }
dan1da40a32009-09-19 17:00:31 +0000633
634 /* Clean up the WHERE clause constructed above. */
635 sqlite3ExprDelete(db, pWhere);
dan0ff297e2009-09-25 17:03:14 +0000636 if( iFkIfZero ){
637 sqlite3VdbeJumpHere(v, iFkIfZero);
638 }
dan1da40a32009-09-19 17:00:31 +0000639}
640
641/*
drhbd50a922013-11-03 02:27:58 +0000642** This function returns a linked list of FKey objects (connected by
643** FKey.pNextTo) holding all children of table pTab. For example,
dan1da40a32009-09-19 17:00:31 +0000644** given the following schema:
645**
646** CREATE TABLE t1(a PRIMARY KEY);
647** CREATE TABLE t2(b REFERENCES t1(a);
648**
649** Calling this function with table "t1" as an argument returns a pointer
650** to the FKey structure representing the foreign key constraint on table
651** "t2". Calling this function with "t2" as the argument would return a
dan8099ce62009-09-23 08:43:35 +0000652** NULL pointer (as there are no FK constraints for which t2 is the parent
653** table).
dan1da40a32009-09-19 17:00:31 +0000654*/
dan432cc5b2009-09-26 17:51:48 +0000655FKey *sqlite3FkReferences(Table *pTab){
dan1da40a32009-09-19 17:00:31 +0000656 int nName = sqlite3Strlen30(pTab->zName);
657 return (FKey *)sqlite3HashFind(&pTab->pSchema->fkeyHash, pTab->zName, nName);
658}
659
dan8099ce62009-09-23 08:43:35 +0000660/*
661** The second argument is a Trigger structure allocated by the
662** fkActionTrigger() routine. This function deletes the Trigger structure
663** and all of its sub-components.
664**
665** The Trigger structure or any of its sub-components may be allocated from
666** the lookaside buffer belonging to database handle dbMem.
667*/
dan75cbd982009-09-21 16:06:03 +0000668static void fkTriggerDelete(sqlite3 *dbMem, Trigger *p){
669 if( p ){
670 TriggerStep *pStep = p->step_list;
671 sqlite3ExprDelete(dbMem, pStep->pWhere);
672 sqlite3ExprListDelete(dbMem, pStep->pExprList);
dan9277efa2009-09-28 11:54:21 +0000673 sqlite3SelectDelete(dbMem, pStep->pSelect);
drh788536b2009-09-23 03:01:58 +0000674 sqlite3ExprDelete(dbMem, p->pWhen);
dan75cbd982009-09-21 16:06:03 +0000675 sqlite3DbFree(dbMem, p);
676 }
677}
678
dan8099ce62009-09-23 08:43:35 +0000679/*
dand66c8302009-09-28 14:49:01 +0000680** This function is called to generate code that runs when table pTab is
681** being dropped from the database. The SrcList passed as the second argument
682** to this function contains a single entry guaranteed to resolve to
683** table pTab.
684**
685** Normally, no code is required. However, if either
686**
687** (a) The table is the parent table of a FK constraint, or
688** (b) The table is the child table of a deferred FK constraint and it is
689** determined at runtime that there are outstanding deferred FK
690** constraint violations in the database,
691**
692** then the equivalent of "DELETE FROM <tbl>" is executed before dropping
693** the table from the database. Triggers are disabled while running this
694** DELETE, but foreign key actions are not.
695*/
696void sqlite3FkDropTable(Parse *pParse, SrcList *pName, Table *pTab){
697 sqlite3 *db = pParse->db;
698 if( (db->flags&SQLITE_ForeignKeys) && !IsVirtual(pTab) && !pTab->pSelect ){
699 int iSkip = 0;
700 Vdbe *v = sqlite3GetVdbe(pParse);
701
702 assert( v ); /* VDBE has already been allocated */
703 if( sqlite3FkReferences(pTab)==0 ){
704 /* Search for a deferred foreign key constraint for which this table
705 ** is the child table. If one cannot be found, return without
706 ** generating any VDBE code. If one can be found, then jump over
707 ** the entire DELETE if there are no outstanding deferred constraints
708 ** when this statement is run. */
709 FKey *p;
710 for(p=pTab->pFKey; p; p=p->pNextFrom){
dana8dbada2013-10-12 15:12:43 +0000711 if( p->isDeferred || (db->flags & SQLITE_DeferFKs) ) break;
dand66c8302009-09-28 14:49:01 +0000712 }
713 if( !p ) return;
714 iSkip = sqlite3VdbeMakeLabel(v);
715 sqlite3VdbeAddOp2(v, OP_FkIfZero, 1, iSkip);
716 }
717
718 pParse->disableTriggers = 1;
719 sqlite3DeleteFrom(pParse, sqlite3SrcListDup(db, pName, 0), 0);
720 pParse->disableTriggers = 0;
721
722 /* If the DELETE has generated immediate foreign key constraint
723 ** violations, halt the VDBE and return an error at this point, before
724 ** any modifications to the schema are made. This is because statement
dana8dbada2013-10-12 15:12:43 +0000725 ** transactions are not able to rollback schema changes.
726 **
727 ** If the SQLITE_DeferFKs flag is set, then this is not required, as
728 ** the statement transaction will not be rolled back even if FK
729 ** constraints are violated.
730 */
731 if( (db->flags & SQLITE_DeferFKs)==0 ){
732 sqlite3VdbeAddOp2(v, OP_FkIfZero, 0, sqlite3VdbeCurrentAddr(v)+2);
733 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_FOREIGNKEY,
drhf9c8ce32013-11-05 13:33:55 +0000734 OE_Abort, 0, P4_STATIC, P5_ConstraintFK);
dana8dbada2013-10-12 15:12:43 +0000735 }
dand66c8302009-09-28 14:49:01 +0000736
737 if( iSkip ){
738 sqlite3VdbeResolveLabel(v, iSkip);
739 }
740 }
741}
742
dan8ff2d952013-09-05 18:40:29 +0000743
744/*
745** The second argument points to an FKey object representing a foreign key
746** for which pTab is the child table. An UPDATE statement against pTab
747** is currently being processed. For each column of the table that is
748** actually updated, the corresponding element in the aChange[] array
749** is zero or greater (if a column is unmodified the corresponding element
750** is set to -1). If the rowid column is modified by the UPDATE statement
751** the bChngRowid argument is non-zero.
752**
753** This function returns true if any of the columns that are part of the
754** child key for FK constraint *p are modified.
755*/
756static int fkChildIsModified(
757 Table *pTab, /* Table being updated */
758 FKey *p, /* Foreign key for which pTab is the child */
759 int *aChange, /* Array indicating modified columns */
760 int bChngRowid /* True if rowid is modified by this update */
761){
762 int i;
763 for(i=0; i<p->nCol; i++){
764 int iChildKey = p->aCol[i].iFrom;
765 if( aChange[iChildKey]>=0 ) return 1;
766 if( iChildKey==pTab->iPKey && bChngRowid ) return 1;
767 }
768 return 0;
769}
770
771/*
772** The second argument points to an FKey object representing a foreign key
773** for which pTab is the parent table. An UPDATE statement against pTab
774** is currently being processed. For each column of the table that is
775** actually updated, the corresponding element in the aChange[] array
776** is zero or greater (if a column is unmodified the corresponding element
777** is set to -1). If the rowid column is modified by the UPDATE statement
778** the bChngRowid argument is non-zero.
779**
780** This function returns true if any of the columns that are part of the
781** parent key for FK constraint *p are modified.
782*/
783static int fkParentIsModified(
784 Table *pTab,
785 FKey *p,
786 int *aChange,
787 int bChngRowid
788){
789 int i;
790 for(i=0; i<p->nCol; i++){
791 char *zKey = p->aCol[i].zCol;
792 int iKey;
793 for(iKey=0; iKey<pTab->nCol; iKey++){
794 if( aChange[iKey]>=0 || (iKey==pTab->iPKey && bChngRowid) ){
795 Column *pCol = &pTab->aCol[iKey];
796 if( zKey ){
797 if( 0==sqlite3StrICmp(pCol->zName, zKey) ) return 1;
798 }else if( pCol->colFlags & COLFLAG_PRIMKEY ){
799 return 1;
800 }
801 }
802 }
803 }
804 return 0;
805}
806
dand66c8302009-09-28 14:49:01 +0000807/*
dan8099ce62009-09-23 08:43:35 +0000808** This function is called when inserting, deleting or updating a row of
809** table pTab to generate VDBE code to perform foreign key constraint
810** processing for the operation.
811**
812** For a DELETE operation, parameter regOld is passed the index of the
813** first register in an array of (pTab->nCol+1) registers containing the
814** rowid of the row being deleted, followed by each of the column values
815** of the row being deleted, from left to right. Parameter regNew is passed
816** zero in this case.
817**
dan8099ce62009-09-23 08:43:35 +0000818** For an INSERT operation, regOld is passed zero and regNew is passed the
819** first register of an array of (pTab->nCol+1) registers containing the new
820** row data.
821**
dan9277efa2009-09-28 11:54:21 +0000822** For an UPDATE operation, this function is called twice. Once before
823** the original record is deleted from the table using the calling convention
824** described for DELETE. Then again after the original record is deleted
dane7a94d82009-10-01 16:09:04 +0000825** but before the new record is inserted using the INSERT convention.
dan8099ce62009-09-23 08:43:35 +0000826*/
dan1da40a32009-09-19 17:00:31 +0000827void sqlite3FkCheck(
828 Parse *pParse, /* Parse context */
829 Table *pTab, /* Row is being deleted from this table */
dan1da40a32009-09-19 17:00:31 +0000830 int regOld, /* Previous row data is stored here */
dan8ff2d952013-09-05 18:40:29 +0000831 int regNew, /* New row data is stored here */
832 int *aChange, /* Array indicating UPDATEd columns (or 0) */
833 int bChngRowid /* True if rowid is UPDATEd */
dan1da40a32009-09-19 17:00:31 +0000834){
835 sqlite3 *db = pParse->db; /* Database handle */
dan1da40a32009-09-19 17:00:31 +0000836 FKey *pFKey; /* Used to iterate through FKs */
837 int iDb; /* Index of database containing pTab */
838 const char *zDb; /* Name of database containing pTab */
danf0662562009-09-28 18:52:11 +0000839 int isIgnoreErrors = pParse->disableTriggers;
dan1da40a32009-09-19 17:00:31 +0000840
dan792e9202009-09-29 11:28:51 +0000841 /* Exactly one of regOld and regNew should be non-zero. */
842 assert( (regOld==0)!=(regNew==0) );
dan1da40a32009-09-19 17:00:31 +0000843
844 /* If foreign-keys are disabled, this function is a no-op. */
845 if( (db->flags&SQLITE_ForeignKeys)==0 ) return;
846
dan1da40a32009-09-19 17:00:31 +0000847 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
848 zDb = db->aDb[iDb].zName;
849
dan8099ce62009-09-23 08:43:35 +0000850 /* Loop through all the foreign key constraints for which pTab is the
851 ** child table (the table that the foreign key definition is part of). */
dan1da40a32009-09-19 17:00:31 +0000852 for(pFKey=pTab->pFKey; pFKey; pFKey=pFKey->pNextFrom){
dan8099ce62009-09-23 08:43:35 +0000853 Table *pTo; /* Parent table of foreign key pFKey */
dan1da40a32009-09-19 17:00:31 +0000854 Index *pIdx = 0; /* Index on key columns in pTo */
dan36062642009-09-21 18:56:23 +0000855 int *aiFree = 0;
856 int *aiCol;
857 int iCol;
858 int i;
dan02470b22009-10-03 07:04:11 +0000859 int isIgnore = 0;
dan1da40a32009-09-19 17:00:31 +0000860
dan8ff2d952013-09-05 18:40:29 +0000861 if( aChange
862 && sqlite3_stricmp(pTab->zName, pFKey->zTo)!=0
863 && fkChildIsModified(pTab, pFKey, aChange, bChngRowid)==0
864 ){
865 continue;
866 }
867
dan8099ce62009-09-23 08:43:35 +0000868 /* Find the parent table of this foreign key. Also find a unique index
869 ** on the parent key columns in the parent table. If either of these
870 ** schema items cannot be located, set an error in pParse and return
871 ** early. */
danf0662562009-09-28 18:52:11 +0000872 if( pParse->disableTriggers ){
873 pTo = sqlite3FindTable(db, pFKey->zTo, zDb);
874 }else{
875 pTo = sqlite3LocateTable(pParse, 0, pFKey->zTo, zDb);
876 }
drh6c5b9152012-12-17 16:46:37 +0000877 if( !pTo || sqlite3FkLocateIndex(pParse, pTo, pFKey, &pIdx, &aiFree) ){
dan3098dc52011-08-22 09:54:26 +0000878 assert( isIgnoreErrors==0 || (regOld!=0 && regNew==0) );
danf0662562009-09-28 18:52:11 +0000879 if( !isIgnoreErrors || db->mallocFailed ) return;
drh9147c7b2011-08-22 20:33:12 +0000880 if( pTo==0 ){
dan3098dc52011-08-22 09:54:26 +0000881 /* If isIgnoreErrors is true, then a table is being dropped. In this
882 ** case SQLite runs a "DELETE FROM xxx" on the table being dropped
883 ** before actually dropping it in order to check FK constraints.
884 ** If the parent table of an FK constraint on the current table is
885 ** missing, behave as if it is empty. i.e. decrement the relevant
886 ** FK counter for each row of the current table with non-NULL keys.
887 */
888 Vdbe *v = sqlite3GetVdbe(pParse);
889 int iJump = sqlite3VdbeCurrentAddr(v) + pFKey->nCol + 1;
890 for(i=0; i<pFKey->nCol; i++){
891 int iReg = pFKey->aCol[i].iFrom + regOld + 1;
892 sqlite3VdbeAddOp2(v, OP_IsNull, iReg, iJump);
893 }
894 sqlite3VdbeAddOp2(v, OP_FkCounter, pFKey->isDeferred, -1);
895 }
danf0662562009-09-28 18:52:11 +0000896 continue;
897 }
dan36062642009-09-21 18:56:23 +0000898 assert( pFKey->nCol==1 || (aiFree && pIdx) );
dan1da40a32009-09-19 17:00:31 +0000899
dan36062642009-09-21 18:56:23 +0000900 if( aiFree ){
901 aiCol = aiFree;
902 }else{
903 iCol = pFKey->aCol[0].iFrom;
904 aiCol = &iCol;
905 }
906 for(i=0; i<pFKey->nCol; i++){
907 if( aiCol[i]==pTab->iPKey ){
908 aiCol[i] = -1;
909 }
dan47a06342009-10-02 14:23:41 +0000910#ifndef SQLITE_OMIT_AUTHORIZATION
dan02470b22009-10-03 07:04:11 +0000911 /* Request permission to read the parent key columns. If the
912 ** authorization callback returns SQLITE_IGNORE, behave as if any
913 ** values read from the parent table are NULL. */
dan47a06342009-10-02 14:23:41 +0000914 if( db->xAuth ){
dan02470b22009-10-03 07:04:11 +0000915 int rcauth;
dan47a06342009-10-02 14:23:41 +0000916 char *zCol = pTo->aCol[pIdx ? pIdx->aiColumn[i] : pTo->iPKey].zName;
dan02470b22009-10-03 07:04:11 +0000917 rcauth = sqlite3AuthReadCol(pParse, pTo->zName, zCol, iDb);
918 isIgnore = (rcauth==SQLITE_IGNORE);
dan47a06342009-10-02 14:23:41 +0000919 }
920#endif
dan36062642009-09-21 18:56:23 +0000921 }
922
dan8099ce62009-09-23 08:43:35 +0000923 /* Take a shared-cache advisory read-lock on the parent table. Allocate
924 ** a cursor to use to search the unique index on the parent key columns
925 ** in the parent table. */
dan1da40a32009-09-19 17:00:31 +0000926 sqlite3TableLock(pParse, iDb, pTo->tnum, 0, pTo->zName);
927 pParse->nTab++;
928
dan32b09f22009-09-23 17:29:59 +0000929 if( regOld!=0 ){
930 /* A row is being removed from the child table. Search for the parent.
931 ** If the parent does not exist, removing the child row resolves an
932 ** outstanding foreign key constraint violation. */
dan02470b22009-10-03 07:04:11 +0000933 fkLookupParent(pParse, iDb, pTo, pIdx, pFKey, aiCol, regOld, -1,isIgnore);
dan1da40a32009-09-19 17:00:31 +0000934 }
935 if( regNew!=0 ){
dan32b09f22009-09-23 17:29:59 +0000936 /* A row is being added to the child table. If a parent row cannot
937 ** be found, adding the child row has violated the FK constraint. */
dan02470b22009-10-03 07:04:11 +0000938 fkLookupParent(pParse, iDb, pTo, pIdx, pFKey, aiCol, regNew, +1,isIgnore);
dan1da40a32009-09-19 17:00:31 +0000939 }
940
dan36062642009-09-21 18:56:23 +0000941 sqlite3DbFree(db, aiFree);
dan1da40a32009-09-19 17:00:31 +0000942 }
943
drhbd50a922013-11-03 02:27:58 +0000944 /* Loop through all the foreign key constraints that refer to this table.
945 ** (the "child" constraints) */
dan432cc5b2009-09-26 17:51:48 +0000946 for(pFKey = sqlite3FkReferences(pTab); pFKey; pFKey=pFKey->pNextTo){
dan1da40a32009-09-19 17:00:31 +0000947 Index *pIdx = 0; /* Foreign key index for pFKey */
948 SrcList *pSrc;
949 int *aiCol = 0;
950
dan8ff2d952013-09-05 18:40:29 +0000951 if( aChange && fkParentIsModified(pTab, pFKey, aChange, bChngRowid)==0 ){
952 continue;
953 }
954
drh648e2642013-07-11 15:03:32 +0000955 if( !pFKey->isDeferred && !(db->flags & SQLITE_DeferFKs)
956 && !pParse->pToplevel && !pParse->isMultiWrite
957 ){
dan32b09f22009-09-23 17:29:59 +0000958 assert( regOld==0 && regNew!=0 );
959 /* Inserting a single row into a parent table cannot cause an immediate
960 ** foreign key violation. So do nothing in this case. */
danf0662562009-09-28 18:52:11 +0000961 continue;
dan1da40a32009-09-19 17:00:31 +0000962 }
963
drh6c5b9152012-12-17 16:46:37 +0000964 if( sqlite3FkLocateIndex(pParse, pTab, pFKey, &pIdx, &aiCol) ){
danf0662562009-09-28 18:52:11 +0000965 if( !isIgnoreErrors || db->mallocFailed ) return;
966 continue;
967 }
dan1da40a32009-09-19 17:00:31 +0000968 assert( aiCol || pFKey->nCol==1 );
969
drhbd50a922013-11-03 02:27:58 +0000970 /* Create a SrcList structure containing the child table. We need the
971 ** child table as a SrcList for sqlite3WhereBegin() */
dan1da40a32009-09-19 17:00:31 +0000972 pSrc = sqlite3SrcListAppend(db, 0, 0, 0);
danf59c5ca2009-09-22 16:55:38 +0000973 if( pSrc ){
drh9a616f52009-10-12 20:01:49 +0000974 struct SrcList_item *pItem = pSrc->a;
975 pItem->pTab = pFKey->pFrom;
976 pItem->zName = pFKey->pFrom->zName;
977 pItem->pTab->nRef++;
978 pItem->iCursor = pParse->nTab++;
danf59c5ca2009-09-22 16:55:38 +0000979
dan32b09f22009-09-23 17:29:59 +0000980 if( regNew!=0 ){
dan9277efa2009-09-28 11:54:21 +0000981 fkScanChildren(pParse, pSrc, pTab, pIdx, pFKey, aiCol, regNew, -1);
danf59c5ca2009-09-22 16:55:38 +0000982 }
983 if( regOld!=0 ){
984 /* If there is a RESTRICT action configured for the current operation
dan8099ce62009-09-23 08:43:35 +0000985 ** on the parent table of this FK, then throw an exception
danf59c5ca2009-09-22 16:55:38 +0000986 ** immediately if the FK constraint is violated, even if this is a
987 ** deferred trigger. That's what RESTRICT means. To defer checking
988 ** the constraint, the FK should specify NO ACTION (represented
989 ** using OE_None). NO ACTION is the default. */
dan9277efa2009-09-28 11:54:21 +0000990 fkScanChildren(pParse, pSrc, pTab, pIdx, pFKey, aiCol, regOld, 1);
danf59c5ca2009-09-22 16:55:38 +0000991 }
drh9a616f52009-10-12 20:01:49 +0000992 pItem->zName = 0;
danf59c5ca2009-09-22 16:55:38 +0000993 sqlite3SrcListDelete(db, pSrc);
dan1da40a32009-09-19 17:00:31 +0000994 }
dan1da40a32009-09-19 17:00:31 +0000995 sqlite3DbFree(db, aiCol);
996 }
997}
998
999#define COLUMN_MASK(x) (((x)>31) ? 0xffffffff : ((u32)1<<(x)))
1000
1001/*
1002** This function is called before generating code to update or delete a
dane7a94d82009-10-01 16:09:04 +00001003** row contained in table pTab.
dan1da40a32009-09-19 17:00:31 +00001004*/
1005u32 sqlite3FkOldmask(
1006 Parse *pParse, /* Parse context */
dane7a94d82009-10-01 16:09:04 +00001007 Table *pTab /* Table being modified */
dan1da40a32009-09-19 17:00:31 +00001008){
1009 u32 mask = 0;
1010 if( pParse->db->flags&SQLITE_ForeignKeys ){
1011 FKey *p;
1012 int i;
1013 for(p=pTab->pFKey; p; p=p->pNextFrom){
dan32b09f22009-09-23 17:29:59 +00001014 for(i=0; i<p->nCol; i++) mask |= COLUMN_MASK(p->aCol[i].iFrom);
dan1da40a32009-09-19 17:00:31 +00001015 }
dan432cc5b2009-09-26 17:51:48 +00001016 for(p=sqlite3FkReferences(pTab); p; p=p->pNextTo){
dan1da40a32009-09-19 17:00:31 +00001017 Index *pIdx = 0;
drh6c5b9152012-12-17 16:46:37 +00001018 sqlite3FkLocateIndex(pParse, pTab, p, &pIdx, 0);
dan1da40a32009-09-19 17:00:31 +00001019 if( pIdx ){
drhbbbdc832013-10-22 18:01:40 +00001020 for(i=0; i<pIdx->nKeyCol; i++) mask |= COLUMN_MASK(pIdx->aiColumn[i]);
dan1da40a32009-09-19 17:00:31 +00001021 }
1022 }
1023 }
1024 return mask;
1025}
1026
dan8ff2d952013-09-05 18:40:29 +00001027
dan1da40a32009-09-19 17:00:31 +00001028/*
1029** This function is called before generating code to update or delete a
dane7a94d82009-10-01 16:09:04 +00001030** row contained in table pTab. If the operation is a DELETE, then
1031** parameter aChange is passed a NULL value. For an UPDATE, aChange points
1032** to an array of size N, where N is the number of columns in table pTab.
1033** If the i'th column is not modified by the UPDATE, then the corresponding
1034** entry in the aChange[] array is set to -1. If the column is modified,
1035** the value is 0 or greater. Parameter chngRowid is set to true if the
1036** UPDATE statement modifies the rowid fields of the table.
dan1da40a32009-09-19 17:00:31 +00001037**
1038** If any foreign key processing will be required, this function returns
1039** true. If there is no foreign key related processing, this function
1040** returns false.
1041*/
1042int sqlite3FkRequired(
1043 Parse *pParse, /* Parse context */
1044 Table *pTab, /* Table being modified */
dane7a94d82009-10-01 16:09:04 +00001045 int *aChange, /* Non-NULL for UPDATE operations */
1046 int chngRowid /* True for UPDATE that affects rowid */
dan1da40a32009-09-19 17:00:31 +00001047){
1048 if( pParse->db->flags&SQLITE_ForeignKeys ){
dane7a94d82009-10-01 16:09:04 +00001049 if( !aChange ){
1050 /* A DELETE operation. Foreign key processing is required if the
1051 ** table in question is either the child or parent table for any
1052 ** foreign key constraint. */
1053 return (sqlite3FkReferences(pTab) || pTab->pFKey);
1054 }else{
1055 /* This is an UPDATE. Foreign key processing is only required if the
1056 ** operation modifies one or more child or parent key columns. */
dane7a94d82009-10-01 16:09:04 +00001057 FKey *p;
1058
1059 /* Check if any child key columns are being modified. */
1060 for(p=pTab->pFKey; p; p=p->pNextFrom){
dan8ff2d952013-09-05 18:40:29 +00001061 if( fkChildIsModified(pTab, p, aChange, chngRowid) ) return 1;
dane7a94d82009-10-01 16:09:04 +00001062 }
1063
1064 /* Check if any parent key columns are being modified. */
1065 for(p=sqlite3FkReferences(pTab); p; p=p->pNextTo){
dan8ff2d952013-09-05 18:40:29 +00001066 if( fkParentIsModified(pTab, p, aChange, chngRowid) ) return 1;
dane7a94d82009-10-01 16:09:04 +00001067 }
1068 }
dan1da40a32009-09-19 17:00:31 +00001069 }
1070 return 0;
1071}
1072
dan8099ce62009-09-23 08:43:35 +00001073/*
1074** This function is called when an UPDATE or DELETE operation is being
1075** compiled on table pTab, which is the parent table of foreign-key pFKey.
1076** If the current operation is an UPDATE, then the pChanges parameter is
1077** passed a pointer to the list of columns being modified. If it is a
1078** DELETE, pChanges is passed a NULL pointer.
1079**
1080** It returns a pointer to a Trigger structure containing a trigger
1081** equivalent to the ON UPDATE or ON DELETE action specified by pFKey.
1082** If the action is "NO ACTION" or "RESTRICT", then a NULL pointer is
1083** returned (these actions require no special handling by the triggers
1084** sub-system, code for them is created by fkScanChildren()).
1085**
1086** For example, if pFKey is the foreign key and pTab is table "p" in
1087** the following schema:
1088**
1089** CREATE TABLE p(pk PRIMARY KEY);
1090** CREATE TABLE c(ck REFERENCES p ON DELETE CASCADE);
1091**
1092** then the returned trigger structure is equivalent to:
1093**
1094** CREATE TRIGGER ... DELETE ON p BEGIN
1095** DELETE FROM c WHERE ck = old.pk;
1096** END;
1097**
1098** The returned pointer is cached as part of the foreign key object. It
1099** is eventually freed along with the rest of the foreign key object by
1100** sqlite3FkDelete().
1101*/
dan1da40a32009-09-19 17:00:31 +00001102static Trigger *fkActionTrigger(
dan8099ce62009-09-23 08:43:35 +00001103 Parse *pParse, /* Parse context */
dan1da40a32009-09-19 17:00:31 +00001104 Table *pTab, /* Table being updated or deleted from */
1105 FKey *pFKey, /* Foreign key to get action for */
1106 ExprList *pChanges /* Change-list for UPDATE, NULL for DELETE */
1107){
1108 sqlite3 *db = pParse->db; /* Database handle */
dan29c7f9c2009-09-22 15:53:47 +00001109 int action; /* One of OE_None, OE_Cascade etc. */
1110 Trigger *pTrigger; /* Trigger definition to return */
dan8099ce62009-09-23 08:43:35 +00001111 int iAction = (pChanges!=0); /* 1 for UPDATE, 0 for DELETE */
dan1da40a32009-09-19 17:00:31 +00001112
dan8099ce62009-09-23 08:43:35 +00001113 action = pFKey->aAction[iAction];
1114 pTrigger = pFKey->apTrigger[iAction];
dan1da40a32009-09-19 17:00:31 +00001115
dan9277efa2009-09-28 11:54:21 +00001116 if( action!=OE_None && !pTrigger ){
dan29c7f9c2009-09-22 15:53:47 +00001117 u8 enableLookaside; /* Copy of db->lookaside.bEnabled */
dan8099ce62009-09-23 08:43:35 +00001118 char const *zFrom; /* Name of child table */
dan1da40a32009-09-19 17:00:31 +00001119 int nFrom; /* Length in bytes of zFrom */
dan29c7f9c2009-09-22 15:53:47 +00001120 Index *pIdx = 0; /* Parent key index for this FK */
1121 int *aiCol = 0; /* child table cols -> parent key cols */
drhd3ceeb52009-10-13 13:08:19 +00001122 TriggerStep *pStep = 0; /* First (only) step of trigger program */
dan29c7f9c2009-09-22 15:53:47 +00001123 Expr *pWhere = 0; /* WHERE clause of trigger step */
1124 ExprList *pList = 0; /* Changes list if ON UPDATE CASCADE */
dan9277efa2009-09-28 11:54:21 +00001125 Select *pSelect = 0; /* If RESTRICT, "SELECT RAISE(...)" */
dan29c7f9c2009-09-22 15:53:47 +00001126 int i; /* Iterator variable */
drh788536b2009-09-23 03:01:58 +00001127 Expr *pWhen = 0; /* WHEN clause for the trigger */
dan1da40a32009-09-19 17:00:31 +00001128
drh6c5b9152012-12-17 16:46:37 +00001129 if( sqlite3FkLocateIndex(pParse, pTab, pFKey, &pIdx, &aiCol) ) return 0;
dan1da40a32009-09-19 17:00:31 +00001130 assert( aiCol || pFKey->nCol==1 );
1131
dan1da40a32009-09-19 17:00:31 +00001132 for(i=0; i<pFKey->nCol; i++){
dan1da40a32009-09-19 17:00:31 +00001133 Token tOld = { "old", 3 }; /* Literal "old" token */
1134 Token tNew = { "new", 3 }; /* Literal "new" token */
dan8099ce62009-09-23 08:43:35 +00001135 Token tFromCol; /* Name of column in child table */
1136 Token tToCol; /* Name of column in parent table */
1137 int iFromCol; /* Idx of column in child table */
dan29c7f9c2009-09-22 15:53:47 +00001138 Expr *pEq; /* tFromCol = OLD.tToCol */
dan1da40a32009-09-19 17:00:31 +00001139
1140 iFromCol = aiCol ? aiCol[i] : pFKey->aCol[0].iFrom;
dana8f0bf62009-09-23 12:06:52 +00001141 assert( iFromCol>=0 );
dan1da40a32009-09-19 17:00:31 +00001142 tToCol.z = pIdx ? pTab->aCol[pIdx->aiColumn[i]].zName : "oid";
dana8f0bf62009-09-23 12:06:52 +00001143 tFromCol.z = pFKey->pFrom->aCol[iFromCol].zName;
dan1da40a32009-09-19 17:00:31 +00001144
1145 tToCol.n = sqlite3Strlen30(tToCol.z);
1146 tFromCol.n = sqlite3Strlen30(tFromCol.z);
1147
dan652ac1d2009-09-29 16:38:59 +00001148 /* Create the expression "OLD.zToCol = zFromCol". It is important
1149 ** that the "OLD.zToCol" term is on the LHS of the = operator, so
1150 ** that the affinity and collation sequence associated with the
1151 ** parent table are used for the comparison. */
dan1da40a32009-09-19 17:00:31 +00001152 pEq = sqlite3PExpr(pParse, TK_EQ,
dan1da40a32009-09-19 17:00:31 +00001153 sqlite3PExpr(pParse, TK_DOT,
1154 sqlite3PExpr(pParse, TK_ID, 0, 0, &tOld),
1155 sqlite3PExpr(pParse, TK_ID, 0, 0, &tToCol)
dan652ac1d2009-09-29 16:38:59 +00001156 , 0),
1157 sqlite3PExpr(pParse, TK_ID, 0, 0, &tFromCol)
dan1da40a32009-09-19 17:00:31 +00001158 , 0);
dan29c7f9c2009-09-22 15:53:47 +00001159 pWhere = sqlite3ExprAnd(db, pWhere, pEq);
dan1da40a32009-09-19 17:00:31 +00001160
drh788536b2009-09-23 03:01:58 +00001161 /* For ON UPDATE, construct the next term of the WHEN clause.
1162 ** The final WHEN clause will be like this:
1163 **
1164 ** WHEN NOT(old.col1 IS new.col1 AND ... AND old.colN IS new.colN)
1165 */
1166 if( pChanges ){
1167 pEq = sqlite3PExpr(pParse, TK_IS,
1168 sqlite3PExpr(pParse, TK_DOT,
1169 sqlite3PExpr(pParse, TK_ID, 0, 0, &tOld),
1170 sqlite3PExpr(pParse, TK_ID, 0, 0, &tToCol),
1171 0),
1172 sqlite3PExpr(pParse, TK_DOT,
1173 sqlite3PExpr(pParse, TK_ID, 0, 0, &tNew),
1174 sqlite3PExpr(pParse, TK_ID, 0, 0, &tToCol),
1175 0),
1176 0);
1177 pWhen = sqlite3ExprAnd(db, pWhen, pEq);
1178 }
1179
dan9277efa2009-09-28 11:54:21 +00001180 if( action!=OE_Restrict && (action!=OE_Cascade || pChanges) ){
dan1da40a32009-09-19 17:00:31 +00001181 Expr *pNew;
1182 if( action==OE_Cascade ){
1183 pNew = sqlite3PExpr(pParse, TK_DOT,
1184 sqlite3PExpr(pParse, TK_ID, 0, 0, &tNew),
1185 sqlite3PExpr(pParse, TK_ID, 0, 0, &tToCol)
1186 , 0);
1187 }else if( action==OE_SetDflt ){
dan934ce302009-09-22 16:08:58 +00001188 Expr *pDflt = pFKey->pFrom->aCol[iFromCol].pDflt;
dan1da40a32009-09-19 17:00:31 +00001189 if( pDflt ){
1190 pNew = sqlite3ExprDup(db, pDflt, 0);
1191 }else{
1192 pNew = sqlite3PExpr(pParse, TK_NULL, 0, 0, 0);
1193 }
1194 }else{
1195 pNew = sqlite3PExpr(pParse, TK_NULL, 0, 0, 0);
1196 }
1197 pList = sqlite3ExprListAppend(pParse, pList, pNew);
1198 sqlite3ExprListSetName(pParse, pList, &tFromCol, 0);
1199 }
1200 }
dan29c7f9c2009-09-22 15:53:47 +00001201 sqlite3DbFree(db, aiCol);
dan1da40a32009-09-19 17:00:31 +00001202
dan9277efa2009-09-28 11:54:21 +00001203 zFrom = pFKey->pFrom->zName;
1204 nFrom = sqlite3Strlen30(zFrom);
1205
1206 if( action==OE_Restrict ){
1207 Token tFrom;
1208 Expr *pRaise;
1209
1210 tFrom.z = zFrom;
1211 tFrom.n = nFrom;
drhf9c8ce32013-11-05 13:33:55 +00001212 pRaise = sqlite3Expr(db, TK_RAISE, "FOREIGN KEY constraint failed");
dan9277efa2009-09-28 11:54:21 +00001213 if( pRaise ){
1214 pRaise->affinity = OE_Abort;
1215 }
1216 pSelect = sqlite3SelectNew(pParse,
1217 sqlite3ExprListAppend(pParse, 0, pRaise),
1218 sqlite3SrcListAppend(db, 0, &tFrom, 0),
1219 pWhere,
1220 0, 0, 0, 0, 0, 0
1221 );
1222 pWhere = 0;
1223 }
1224
drhb2468952010-07-23 17:06:32 +00001225 /* Disable lookaside memory allocation */
dan29c7f9c2009-09-22 15:53:47 +00001226 enableLookaside = db->lookaside.bEnabled;
drh46803c32009-09-24 14:27:33 +00001227 db->lookaside.bEnabled = 0;
dan29c7f9c2009-09-22 15:53:47 +00001228
dan29c7f9c2009-09-22 15:53:47 +00001229 pTrigger = (Trigger *)sqlite3DbMallocZero(db,
1230 sizeof(Trigger) + /* struct Trigger */
1231 sizeof(TriggerStep) + /* Single step in trigger program */
1232 nFrom + 1 /* Space for pStep->target.z */
1233 );
1234 if( pTrigger ){
1235 pStep = pTrigger->step_list = (TriggerStep *)&pTrigger[1];
1236 pStep->target.z = (char *)&pStep[1];
1237 pStep->target.n = nFrom;
1238 memcpy((char *)pStep->target.z, zFrom, nFrom);
1239
1240 pStep->pWhere = sqlite3ExprDup(db, pWhere, EXPRDUP_REDUCE);
1241 pStep->pExprList = sqlite3ExprListDup(db, pList, EXPRDUP_REDUCE);
dan9277efa2009-09-28 11:54:21 +00001242 pStep->pSelect = sqlite3SelectDup(db, pSelect, EXPRDUP_REDUCE);
drh788536b2009-09-23 03:01:58 +00001243 if( pWhen ){
1244 pWhen = sqlite3PExpr(pParse, TK_NOT, pWhen, 0, 0);
1245 pTrigger->pWhen = sqlite3ExprDup(db, pWhen, EXPRDUP_REDUCE);
1246 }
dan29c7f9c2009-09-22 15:53:47 +00001247 }
1248
1249 /* Re-enable the lookaside buffer, if it was disabled earlier. */
1250 db->lookaside.bEnabled = enableLookaside;
1251
drh788536b2009-09-23 03:01:58 +00001252 sqlite3ExprDelete(db, pWhere);
1253 sqlite3ExprDelete(db, pWhen);
1254 sqlite3ExprListDelete(db, pList);
dan9277efa2009-09-28 11:54:21 +00001255 sqlite3SelectDelete(db, pSelect);
dan29c7f9c2009-09-22 15:53:47 +00001256 if( db->mallocFailed==1 ){
1257 fkTriggerDelete(db, pTrigger);
1258 return 0;
1259 }
drhb07028f2011-10-14 21:49:18 +00001260 assert( pStep!=0 );
dan1da40a32009-09-19 17:00:31 +00001261
dan9277efa2009-09-28 11:54:21 +00001262 switch( action ){
1263 case OE_Restrict:
1264 pStep->op = TK_SELECT;
1265 break;
1266 case OE_Cascade:
1267 if( !pChanges ){
1268 pStep->op = TK_DELETE;
1269 break;
1270 }
1271 default:
1272 pStep->op = TK_UPDATE;
1273 }
dan1da40a32009-09-19 17:00:31 +00001274 pStep->pTrig = pTrigger;
1275 pTrigger->pSchema = pTab->pSchema;
1276 pTrigger->pTabSchema = pTab->pSchema;
dan8099ce62009-09-23 08:43:35 +00001277 pFKey->apTrigger[iAction] = pTrigger;
1278 pTrigger->op = (pChanges ? TK_UPDATE : TK_DELETE);
dan1da40a32009-09-19 17:00:31 +00001279 }
1280
1281 return pTrigger;
1282}
1283
dan1da40a32009-09-19 17:00:31 +00001284/*
1285** This function is called when deleting or updating a row to implement
1286** any required CASCADE, SET NULL or SET DEFAULT actions.
1287*/
1288void sqlite3FkActions(
1289 Parse *pParse, /* Parse context */
1290 Table *pTab, /* Table being updated or deleted from */
1291 ExprList *pChanges, /* Change-list for UPDATE, NULL for DELETE */
dan8ff2d952013-09-05 18:40:29 +00001292 int regOld, /* Address of array containing old row */
1293 int *aChange, /* Array indicating UPDATEd columns (or 0) */
1294 int bChngRowid /* True if rowid is UPDATEd */
dan1da40a32009-09-19 17:00:31 +00001295){
1296 /* If foreign-key support is enabled, iterate through all FKs that
1297 ** refer to table pTab. If there is an action associated with the FK
1298 ** for this operation (either update or delete), invoke the associated
1299 ** trigger sub-program. */
1300 if( pParse->db->flags&SQLITE_ForeignKeys ){
1301 FKey *pFKey; /* Iterator variable */
dan432cc5b2009-09-26 17:51:48 +00001302 for(pFKey = sqlite3FkReferences(pTab); pFKey; pFKey=pFKey->pNextTo){
dan8ff2d952013-09-05 18:40:29 +00001303 if( aChange==0 || fkParentIsModified(pTab, pFKey, aChange, bChngRowid) ){
1304 Trigger *pAct = fkActionTrigger(pParse, pTab, pFKey, pChanges);
1305 if( pAct ){
1306 sqlite3CodeRowTriggerDirect(pParse, pAct, pTab, regOld, OE_Abort, 0);
1307 }
dan1da40a32009-09-19 17:00:31 +00001308 }
1309 }
1310 }
1311}
1312
dan75cbd982009-09-21 16:06:03 +00001313#endif /* ifndef SQLITE_OMIT_TRIGGER */
1314
dan1da40a32009-09-19 17:00:31 +00001315/*
1316** Free all memory associated with foreign key definitions attached to
1317** table pTab. Remove the deleted foreign keys from the Schema.fkeyHash
1318** hash table.
1319*/
dan1feeaed2010-07-23 15:41:47 +00001320void sqlite3FkDelete(sqlite3 *db, Table *pTab){
dan1da40a32009-09-19 17:00:31 +00001321 FKey *pFKey; /* Iterator variable */
1322 FKey *pNext; /* Copy of pFKey->pNextFrom */
1323
drh21206082011-04-04 18:22:02 +00001324 assert( db==0 || sqlite3SchemaMutexHeld(db, 0, pTab->pSchema) );
dan1da40a32009-09-19 17:00:31 +00001325 for(pFKey=pTab->pFKey; pFKey; pFKey=pNext){
1326
1327 /* Remove the FK from the fkeyHash hash table. */
dand46def72010-07-24 11:28:28 +00001328 if( !db || db->pnBytesFreed==0 ){
1329 if( pFKey->pPrevTo ){
1330 pFKey->pPrevTo->pNextTo = pFKey->pNextTo;
1331 }else{
1332 void *p = (void *)pFKey->pNextTo;
1333 const char *z = (p ? pFKey->pNextTo->zTo : pFKey->zTo);
1334 sqlite3HashInsert(&pTab->pSchema->fkeyHash, z, sqlite3Strlen30(z), p);
1335 }
1336 if( pFKey->pNextTo ){
1337 pFKey->pNextTo->pPrevTo = pFKey->pPrevTo;
1338 }
dan1da40a32009-09-19 17:00:31 +00001339 }
dand46def72010-07-24 11:28:28 +00001340
1341 /* EV: R-30323-21917 Each foreign key constraint in SQLite is
1342 ** classified as either immediate or deferred.
1343 */
1344 assert( pFKey->isDeferred==0 || pFKey->isDeferred==1 );
dan1da40a32009-09-19 17:00:31 +00001345
1346 /* Delete any triggers created to implement actions for this FK. */
dan75cbd982009-09-21 16:06:03 +00001347#ifndef SQLITE_OMIT_TRIGGER
dan1feeaed2010-07-23 15:41:47 +00001348 fkTriggerDelete(db, pFKey->apTrigger[0]);
1349 fkTriggerDelete(db, pFKey->apTrigger[1]);
dan75cbd982009-09-21 16:06:03 +00001350#endif
dan1da40a32009-09-19 17:00:31 +00001351
dan1da40a32009-09-19 17:00:31 +00001352 pNext = pFKey->pNextFrom;
dan1feeaed2010-07-23 15:41:47 +00001353 sqlite3DbFree(db, pFKey);
dan1da40a32009-09-19 17:00:31 +00001354 }
1355}
dan75cbd982009-09-21 16:06:03 +00001356#endif /* ifndef SQLITE_OMIT_FOREIGN_KEY */