Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
| Comment: | Begin writing the VDBE tutorial (CVS 107) |
|---|---|
| Downloads: | Tarball | ZIP archive |
| Timelines: | family | ancestors | descendants | both | trunk |
| Files: | files | file ages | folders |
| SHA1: |
79ce59cf79df3da2c9dcb944dba15c64 |
| User & Date: | drh 2000-06-23 19:16:23.000 |
Context
|
2000-06-26
| ||
| 12:02 | :-) (CVS 108) (check-in: 937c27b7e1 user: drh tags: trunk) | |
|
2000-06-23
| ||
| 19:16 | Begin writing the VDBE tutorial (CVS 107) (check-in: 79ce59cf79 user: drh tags: trunk) | |
| 17:02 | :-) (CVS 1699) (check-in: e970079cc1 user: drh tags: trunk) | |
Changes
Changes to www/changes.tcl.
| ︙ | ︙ | |||
12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
}
proc chng {date desc} {
puts "<DT><B>$date</B></DT>"
puts "<DD><P><UL>$desc</UL></P></DD>"
}
chng {2000 June 21} {
<li>Clean up comments and variable names. Changes to documentation.
No functional changes to the code.</li>
}
chng {2000 June 19} {
| > > > > | 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
}
proc chng {date desc} {
puts "<DT><B>$date</B></DT>"
puts "<DD><P><UL>$desc</UL></P></DD>"
}
chng {2000 June 23} {
<li>Begin writing the <a href="vdbe.html">VDBE tutorial</a>.</li>
}
chng {2000 June 21} {
<li>Clean up comments and variable names. Changes to documentation.
No functional changes to the code.</li>
}
chng {2000 June 19} {
|
| ︙ | ︙ |
Changes to www/vdbe.tcl.
1 2 3 | # # Run this Tcl script to generate the vdbe.html file. # | | | 1 2 3 4 5 6 7 8 9 10 11 |
#
# Run this Tcl script to generate the vdbe.html file.
#
set rcsid {$Id: vdbe.tcl,v 1.2 2000/06/23 19:16:23 drh Exp $}
puts {<html>
<head>
<title>The Virtual Database Engine of SQLite</title>
</head>
<body bgcolor=white>
<h1 align=center>
|
| ︙ | ︙ | |||
78 79 80 81 82 83 84 | <h2>Inserting Records Into The Database</h2> <p>We begin with a problem that can be solved using a VDBE program that is only a few instructions long. Suppose we have an SQL table that was created like this:</p> <blockquote><pre> | | | | | | 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
<h2>Inserting Records Into The Database</h2>
<p>We begin with a problem that can be solved using a VDBE program
that is only a few instructions long. Suppose we have an SQL
table that was created like this:</p>
<blockquote><pre>
CREATE TABLE ex(one text, two int);
</pre></blockquote>
<p>In words, we have a database table named "ex" that has two
columns of data named "one" and "two". Now suppose we want to insert a single
record into this table. Like this:</p>
<blockquote><pre>
INSERT INTO ex VALUES('Hello, World!',99);
</pre></blockquote>
<p>We can see the VDBE program that SQLite uses to implement this
INSERT using the <b>sqlite</b> command-line utility. First start
up <b>sqlite</b> on a new, empty database, then create the table.
Finally, enter the INSERT statement shown above, but precede the
INSERT with the special keyword "EXPLAIN". The EXPLAIN keyword
|
| ︙ | ︙ | |||
111 112 113 114 115 116 117 |
regsub -all {\)\)\)} $body {</u></font>} body
puts $body
puts {</pre></blockquote>}
}
Code {
$ (((sqlite test_database_1)))
| | | | > | | | | | > > > > > > > | | | | | | | | | > > | | | | 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 |
regsub -all {\)\)\)} $body {</u></font>} body
puts $body
puts {</pre></blockquote>}
}
Code {
$ (((sqlite test_database_1)))
sqlite> (((CREATE TABLE examp(one text, two int);)))
sqlite> (((.explain)))
sqlite> (((EXPLAIN INSERT INTO examp VALUES('Hello, World!',99);)))
addr opcode p1 p2 p3
---- ------------ ----- ----- ----------------------------------------
0 Open 0 1 examp
1 New 0 0
2 String 0 0 Hello, World!
3 Integer 99 0
4 MakeRecord 2 0
5 Put 0 0
}
puts {<p>As you can see above, our simple insert statement is
implemented in just 6 instructions. There are no jumps, so the
program executes once through from top to bottom. Let's now
look at each instruction in detail.</p>
<p>The first instruction opens a cursor that points into the
"examp" table. The P1 operand is a handle for the cursor: zero
in this case. Cursor handles can be any non-negative integer.
But the VDBE allocates cursors in an array with the size of the
array being one more than the largest cursor. So to conserve
memory, it is best to use handles beginning with zero and
working upward consecutively.</p>
<p>The P2 operand to the open instruction is 1 which means
that the cursor is opened for writing. 0 would have been used
for P2 if we wanted to open the cursor for reading only.
It is acceptable to open more than one cursor to the same
database file at the same time. But all simultaneously
opened cursors must be opened with the same P2 value. It is
not allowed to have one cursor open for reading a file and
another cursor open for writing that same file.</p>
<p>The second instruction, New, generates an integer key that
has not been previously used in the file "examp". The New instruction
uses its P1 operand as the handle of a cursor for the file
for which the new key will be generated. The new key is
pushed onto the stack. The P2 and P3 operands are not used
by the New instruction.</p>
<p>The third instruction, String, simply pushes its P3
operand onto the stack. After the string instruction executes,
the stack will contain two elements, as follows:</p>
}
proc stack args {
puts "<blockquote><table border=2>"
foreach elem $args {
puts "<tr><td align=center>$elem</td></tr>"
}
puts "</table></blockquote>"
}
stack {The string "Hello, World!"} {A random integer key}
puts {<p>The 4th instruction pushes an integer value 99 onto the
stack. After the 4th instruction executes, the stack looks like this:</p>
}
stack {Integer value 99} {The string "Hello, World!"} {A random integer key}
puts {<p>The 5th instructionn, MakeRecord, pops the top P1
elements off the stack (2 elements in this case) and converts them
all into the binary format used for storing records in a
database file. (See the <a href="fileformat.html">file format</a>
description for details.) The record format consists of
a header with one integer for each column giving the offset
into the record for the beginning of data for that column.
Following the header is the data for each column, Each column
is stored as a null-terminated ASCII text string. The new
record generated by the MakeRecord instruction is pushed back
onto the stack, so that after the 5th instruction executes,
the stack looks like this:</p>
}
stack {A data record holding "Hello, World!" and 99} \
{A random integer key}
puts {<p>The last instruction pops top elements from the stack
and uses them as data and key to make a new entry in database
database file pointed to by cursor P1. This instruction is where
the insert actually occurs.</p>
<p>After the last instruction executes, the program counter
advances to one past the last instruction, which causes the
VDBE to halt. When the VDBE halts, it automatically closes
all open cursors, frees any elements left on the stack,
and releases any other resources we may have allocated.
In this case, the only cleanup necessary is to close the
open cursor to the "examp" file.</p>
<a name="trace">
<h2>Tracing VDBE Program Execution</h2>
<p>If the SQLite library is compiled without the NDEBUG
preprocessor macro being defined, then
there is a special SQL comment that will cause the
the VDBE to traces the execution of programs.
Though this features was originally intended for testing
and debugging, it might also be useful in learning about
how the VDBE operates.
Use the "<tt>--vdbe-trace-on--</tt>" comment to
turn tracing on and "<tt>--vdbe-trace-off--</tt>" to turn tracing
back off. Like this:</p>
}
Code {
sqlite> (((--vdbe-trace-on--)))
...> (((INSERT INTO examp VALUES('Hello, World!',99);)))
0 Open 0 1 examp
1 New 0 0
Stack: i:1053779177
2 String 0 0 Hello, World!
Stack: s:[Hello, Worl] i:1053779177
3 Integer 99 0
Stack: i:99 s:[Hello, Worl] i:1053779177
4 MakeRecord 2 0
Stack: z:] i:1053779177
5 Put 0 0
}
puts {
<p>With tracing mode on, the VDBE prints each instruction prior
to executing it. After the instruction is executed, the top few
entries in the stack are displayed. The stack display is omitted
if the stack is empty.</p>
|
| ︙ | ︙ | |||
255 256 257 258 259 260 261 | <h2>Simple Queries</h2> <p>At this point, you should understand the basics of how the VDBE writes to a database. Now let's look at how it does queries. We will use the follow simple SELECT statement as our example:</p> <blockquote><pre> | | | < < | | > | | | > | | | | 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 |
<h2>Simple Queries</h2>
<p>At this point, you should understand the basics of how the VDBE
writes to a database. Now let's look at how it does queries.
We will use the follow simple SELECT statement as our example:</p>
<blockquote><pre>
SELECT * FROM examp;
</pre></blockquote>
<p>The VDBE program generated for this SQL statement is as follows:</p>
}
Code {
sqlite> (((EXPLAIN SELECT * FROM examp;)))
0 ColumnCount 2 0
1 ColumnName 0 0 one
2 ColumnName 1 0 two
3 Open 0 0 examp
4 Next 0 9
5 Field 0 0
6 Field 0 1
7 Callback 2 0
8 Goto 0 4
9 Close 0 0
}
puts {
<p>Before we begin looking at this problem, let's briefly review
how queries work in SQLite so that we will know what we are trying
to accomplish. For each row in the result of a query,
SQLite will invoke a callback function with the following
|
| ︙ | ︙ | |||
295 296 297 298 299 300 301 | come up with values for <b>nColumn</b>, <b>azData[]</b>, and <b>azColumnName[]</b>. <b>nColumn</b> is the number of columns in the results, of course. <b>azColumnName[]</b> is an array of strings where each string is the name of one of the result column. <b>azData[]</b> is an array of strings holding the actual data.</p> | | | | | | | | | | | | | | | > | | | > | | | | | | | | > | | | | | < < < | | | > | | | | | | < | | | | | | | | | | | < | | | | | | | | | | 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 |
come up with values for <b>nColumn</b>, <b>azData[]</b>,
and <b>azColumnName[]</b>.
<b>nColumn</b> is the number of columns in the results, of course.
<b>azColumnName[]</b> is an array of strings where each string is the name
of one of the result column. <b>azData[]</b> is an array of strings holding
the actual data.</p>
<p>The first three instructions in the VDBE program for our query are
concerned with setting up values for <b>azColumn</b>.
The ColumnCount instruction tells the VDBE how much space to allocate
for the <b>azColumnName[]</b> array. The ColumnName instructions
tell the VDBE what values to fill in for each element of the
<b>azColumnName[]</b> array. Every query will begin with one
ColumnCount instruction and one ColumnName instruction for each
column in the result.</p>
<p>The 4th instruction opens a cursor into the database file
that is to be queried. This works the same as the Open instruction
in the INSERT example except that the
cursor is opened for reading this time instead of for writing.</p>
<p>The instructions at address 4 and 8 form a loop that will execute
once for each record in the database file. This is a key concept that
you should pay close attention to. The Next instruction at
address 4 tells the VDBE to advance the cursor (identified by P1)
to the next record. The first time this Next instruction is executed,
the cursor is set to the first record of the file. If there are
no more records in the database file when Next is executed, then
the VDBE makes an immediate jump over the body of the loop to
instruction 9 (specified by operand P2). The body of the loop
is formed by instructions at addresses 5, 6, and 7. After the loop
body is an unconditional jump at instruction 8 which takes us
back to the Next instruction at the beginning of the loop.
</p>
<p>The body of the loop consists of instructions at addresses 5 through
7. The Field instructions at addresses 5 and 6 each
take the P2-th column from
the P1-th cursor and pushes it onto the stack.
(The "Field" instruction probably should be renamed as the "Column"
instruction.) In this example, the first Field instruction is pushing the
value for the "one" data column onto the stack and the second Field
instruction is pushing the data for "two".</p>
<p>The Callback instruction at address 7 invokes the callback function.
The P1 operand to callback becomes the value for <b>nColumn</b>.
The Callback instruction also pops P1 values from the stack and
uses them to form the <b>azData[]</b> for the callback.</p>
<p>The Close instruction at the end of the program closes the
cursor that points into the database file. It is not really necessary
to call Close here since all cursors will be automatically closed
by the VDBE when the program halts. But we needed an instruction
for the Next to jump to so we might as well go ahead and have that
instruction do something useful.</p>
<a name="query2">
<h2>A Slightly More Complex Query</h2>
<p>The key points of the previous example where the use of the Callback
instruction to invoke the callback function, and the use of the Next
instruction to implement a loop over all records of the database file.
This example attempts to drive home those ideas by demonstrating a
slightly more complex query that involves more columns of
output, some of which are computed values, and a WHERE clause that
limits which records actually make it to the callback function.
Consider this query:</p>
<blockquote><pre>
SELECT one, two, one || two AS 'both'
FROM examp
WHERE one LIKE 'H%'
</pre></blockquote>
<p>This query is perhaps a bit contrived, but it does serve to
illustrate our points. The result will have three column with
names "one", "two", and "both". The first two columns are direct
copies of the two columns in the table and the third result
column is a string formed by concatenating the first and
second columns of the table.
Finally, the
WHERE clause says that we will only chose rows for the
results where the "one" column begins with an "H".
Here is what the VDBE program looks like for this query:</p>
}
Code {
addr opcode p1 p2 p3
---- ------------ ----- ----- ----------------------------------------
0 ColumnCount 3 0
1 ColumnName 0 0 one
2 ColumnName 1 0 two
3 ColumnName 2 0 both
4 Open 0 0 examp
5 Next 0 16
6 Field 0 0
7 String 0 0 H%
8 Like 1 5
9 Field 0 0
10 Field 0 1
11 Field 0 0
12 Field 0 1
13 Concat 2 0
14 Callback 3 0
15 Goto 0 5
16 Close 0 0
}
puts {
<p>Except for the WHERE clause, the structure of the program for
this example is very much like the prior example, just with an
extra column. The ColumnCount is 3 now, instead of 2 as before,
and there are three ColumnName instructions.
A cursor is opened using the Open instruction, just like in the
prior example. The Next instruction at address 5 and the
Goto at address 15 form a loop over all records of the database
file. The Close instruction at the end is there to give the
Next instruction something to jump to when it is done. All of
this is just like in the first query demonstration.</p>
<p>The Callback instruction in this example has to generate
data for three result columns instead of two, but is otherwise
the same as in the first query. When the Callback instruction
is invoked, the left-most column of the result should be
the lowest in the stack and the right-most result column should
be the top of the stack. We can see the stack being set up
this way at addresses 9 through 13. The Field instructions at
9 and 10 push the values for the first two columns in the result.
The two Field instructions at 11 and 12 pull in the values needed
to compute the third result column and the Concat instruction at
13 joins them together into a single entry on the stack.</p>
<p>The only thing that is really new about the current example
is the WHERE clause which is implemented by instructions at
addresses 6, 7, and 8. Instructions at address 6 and 7 push
onto the stack the value of the "one" column from the table
and the literal string "H%". The Like instruction at address 8 pops these
two values from the stack and causes an
immediate jump back to the Next instruction if the "one" value
is <em>not</em> like the literal string "H%". Taking this
jump effectively skips the callback, which is the whole point
of the WHERE clause. If the result
of the comparison is true, the jump is not taken and control
falls through to the Callback instruction below.</p>
<p>Notice how the Like instruction works. It uses the top of
the stack as its pattern and the next on stack as the data
to compare. Because P1 is 1, a jump is made to P2 if the
comparison fails. So with P1 equal to one, a more precise
name for this instruction might be "Jump If NOS Is Not Like TOS".
The sense of the test in inverted if P1 is 0. So when P1
is zero, the instruction is "Jump If NOS Is Like TOS".
</p>
<a name="pattern1">
<h2>A Template For SELECT Programs</h2>
<p>The first two query examples illustrate a kind of template that
every SELECT program will follow. Basically, we have:</p>
|
| ︙ | ︙ | |||
479 480 481 482 483 484 485 | <p>The UPDATE and DELETE statements are coded using a template that is very similar to the SELECT statement template. The main difference, of course, is that the end action is to modify the database rather than invoke a callback function. Let's begin by looking at a DELETE statement:</p> <blockquote><pre> | | | | | < | | | | | | | | | | | | | | | | < | < < | | | | | | | | | | | | | | | | | | | > > > | | | | | | | | | < | | | | | | | | | > > > | | > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 |
<p>The UPDATE and DELETE statements are coded using a template
that is very similar to the SELECT statement template. The main
difference, of course, is that the end action is to modify the
database rather than invoke a callback function. Let's begin
by looking at a DELETE statement:</p>
<blockquote><pre>
DELETE FROM examp WHERE two<50;
</pre></blockquote>
<p>This DELETE statement will remove every record from the "examp"
table where the "two" column is less than 50.
The code generated to do this is as follows:</p>
}
Code {
addr opcode p1 p2 p3
---- ------------ ----- ----- ----------------------------------------
0 ListOpen 0 0
1 Open 0 0 examp
2 Next 0 9
3 Field 0 1
4 Integer 50 0
5 Ge 0 2
6 Key 0 0
7 ListWrite 0 0
8 Goto 0 2
9 Close 0 0
10 ListRewind 0 0
11 Open 0 1 examp
12 ListRead 0 15
13 Delete 0 0
14 Goto 0 12
15 ListClose 0 0
}
puts {
<p>Here is what the program must do. First it has to locate all of
the records in the "examp" database that are to be deleted. This is
done using a loop very much like the loop used in the SELECT examples
above. Once all records have been located, then we can go back through
an delete them one by one. Note that we cannot delete each record
as soon as we find it. We have to locate all records first, then
go back and delete them. This is because the GDBM database
backend might change the scan order after a delete operation.
And if the scan
order changes in the middle of the scan, some records might be
tested more than once, and some records might not be tested at all.</p>
<p>So the implemention of DELETE is really in two loops. The
first loop (instructions 2 through 8 in the example) locates the records that
are to be deleted and the second loop (instructions 12 through 14)
do the actual deleting.</p>
<p>The very first instruction in the program, the ListOpen instruction,
creates a new List object in which we can store the keys of the records
that are to be deleted. The P1 operand serves as a handle to the
list. As with cursors, you can open as many lists as you like
(though in practice we never need more than one at a time.) Each list
has a handle specified by P1 which is a non-negative integer. The
VDBE allocates an array of handles, so it is best to use only small
handles. As currently implemented, SQLite never uses more than one
list at a time and so it always uses the handle of 0 for every list.</p>
<p>Lists are implemented using temporary files.
The program will work like this:
the first loop will locate records that need to
be deleted and write their keys onto the list. Then the second
loop will playback the list and delete the records one by one.</p>
<p>The second instruction opens a cursor to the database file "examp".
Notice that the cursor is opened for reading, not writing. At this
stage of the program we are going to be scanning the file not changing
it. We will reopen the same file for writing it later, at instruction 11.
</p>
<p>Following the Open, there is a loop composed of the Next instruction
at address 2 and continuing down to the Goto at 8. This loop works
the same way as the query loops worked in the prior examples. But
instead of invoking a callback at the end of each loop iteration, this
program calls ListWrite at instruction 7. The ListWrite instruction
pops an integer from the stack and appends it to the List identified
by P1. The integer is a key to a record that should be deleted and
was placed on the stack by the preceding Key instruction.
The WHERE clause is implemented by instructions 3, 4, and 5.
The job of the where clause is to skip the ListWrite if the WHERE
condition is false. To this end, it jumps back to the Next instruction
if the "two" column (extracted by the Field instruction at 3) is
greater than or equal to 50.</p>
<p>At the end of the first loop, the cursor is closed at instruction 9,
and the list is rewound back to the beginning at instruction 10.
The Open instruction at 11 reopens the same database file, but for
writing this time. The loop that does the actual deleting of records
is on instructions 12, 13, and 14.</p>
<p>The ListRead instruction as 12 reads a single integer key from
the list and pushes that key onto the stack. If there are no
more keys, nothing gets pushed onto the stack but instead a jump
is made to instruction 15. Notice the similarity
between the ListRead and Next instructions. Both operations work
according to this rule:</p>
<blockquote>
Push the next "thing" onto the stack and fall through.
Or if there is no next "thing" to push, jump immediately to P2.
</blockquote>
<p>The only difference between Next and ListRead is their idea
of a "thing". The "things" for the Next instruction are records
in a database file. "Things" for ListRead are integer keys in a list.
Later on,
we will see other looping instructions (NextIdx and SortNext) that
operating using the same principle.</p>
<p>The Delete instruction at address 13 pops an integer key from
the stack (the key was put there by the preceding ListRead
instruction) and deletes the record of cursor P1 that has that key.
If there is no record in the database with the given key, then
Delete is a no-op.</p>
<p>There is a Goto instruction at 14 to complete the second loop.
Then at instruction 15 is as ListClose operation. The ListClose
closes the list and deletes the temporary file that held it.
Calling ListClose is optional. The VDBE will automatically close
the list when it halts. But we need an instruction for the
ListRead to jump to when it reaches the end of the list and
ListClose seemed like a natural candidate.</p>
<p>UPDATE statements work very much like DELETE statements except
that instead of deleting the record they replace it with a new one.
Consider this example:
</p>
<blockquote><pre>
UPDATE examp SET one= '(' || one || ')' WHERE two < 50;
</pre></blockquote>
<p>Instead of deleting records where the "two" column is less than
50, this statement just puts the "one" column in paraentheses
The VDBE program to implement this statement follows:</p>
}
Code {
addr opcode p1 p2 p3
---- ------------ ----- ----- ----------------------------------------
0 ListOpen 0 0
1 Open 0 0 examp
2 Next 0 9
3 Field 0 1
4 Integer 50 0
5 Ge 0 2
6 Key 0 0
7 ListWrite 0 0
8 Goto 0 2
9 Close 0 0
10 ListRewind 0 0
11 Open 0 1 examp
12 ListRead 0 24
13 Dup 0 0
14 Fetch 0 0
15 String 0 0 (
16 Field 0 0
17 Concat 2 0
18 String 0 0 )
19 Concat 2 0
20 Field 0 1
21 MakeRecord 2 0
22 Put 0 0
23 Goto 0 12
24 ListClose 0 0
}
puts {
<p>This program is exactly the same as the DELETE program
except that the single Delete instruction in the second loop
has been replace by a sequence of instructions (at addresses
13 through 22) that update the record rather than delete it.
Most of this instruction sequence should already be familiar to
you, but there are a couple of minor twists so we will go
over it briefly.</p>
<p>As we enter the interior of the second loop (at instruction 13)
the stack contains a single integer which is the key of the
record we want to modify. We are going to need to use this
key twice: once to fetch the old value of the record and
a second time to write back the revised record. So the first instruction
is a Dup to make a duplicate of the key on the top of the stack. The
Dup instruction will duplicate any element of the stack, not just the top
element. You specify which element to duplication using the
P1 operand. When P1 is 0, the top of the stack is duplicated.
When P1 is 1, the next element down on the stack duplication.
And so forth.</p>
<p>After duplicating the key, the next instruction, Fetch,
pops the stack once and uses the value popped as a key to
load a record from the database file. In this way, we obtain
the old column values for the record that is about to be
updated.</p>
<p>Instructions 15 through 21 construct a new database record
that will be used to replace the existing record. This is
the same kind of code that we saw
in the description of INSERT and will not be described further.
After instruction 21 executes, the stack looks like this:</p>
}
stack {New data record} {Integer key}
puts {
<p>The Put instruction (also described
during the discussion about INSERT) writes an entry into the
database file whose data is the top of the stack and whose key
is the next on the stack, and then pops the stack twice. The
Put instruction will overwrite the data of an existing record
with the same key, which is what we want here. Overwriting was not
an issue with INSERT because with INSERT the key was generated
by the Key instruction which is guaranteed to provide a key
that has not been used before.</p>
}
if 0 {(By the way, since keys must
all be unique and each key is a 32-bit integer, a single
SQLite database table can have no more than 2<sup>32</sup>
rows. Actually, the Key instruction starts to become
very inefficient as you approach this upper bound, so it
is best to keep the number of entries below 2<sup>31</sup>
or so. Surely a couple billion records will be enough for
most applications!)</p>
}
puts {
<h2>CREATE and DROP</h2>
<p>Using CREATE or DROP to create or destroy a table or index is
really the same as doing an INSERT or DELETE from the special
"sqlite_master" table, at least from the point of view of the VDBE.
The sqlite_master table is a special table that is automatically
created for every SQLite database. It looks like this:</p>
<blockquote><pre>
CREATE TABLE sqlite_master (
type TEXT, -- either "table" or "index"
name TEXT, -- name of the table or index
tbl_name TEXT, -- for indices: name of associated table
sql TEXT -- SQL text of the original CREATE statement
)
</pre></blockquote>
<p>Every table (except the "sqlite_master" table itself)
and every named index in an SQLite database has an entry
in the sqlite_master table. You can query this table using
a SELECT statement just like any other table. But you are
not allowed to directly change the table using UPDATE, INSERT,
or DELETE. Changes to sqlite_master have to occur using
the CREATE and DROP commands because SQLite also has to update
some of its internal data structures when tables and indices
are added or destroyed.</p>
<p>But from the point of view of the VDBE, a CREATE works
pretty much like an INSERT and a DROP works like a DELETE.
When the SQLite library opens to an existing database,
the first thing it does is a SELECT to read the "sql"
columns from all entries of the sqlite_master table.
The "sql" column contains the complete SQL text of the
CREATE statement that originally generated the index or
table. This text is fed back into the SQLite parse
and used to reconstruct the
internal data structures describing the index or table.</p>
<h2>Using Indexes To Speed Searches</h2>
<i>TBD</i>
<h2>Joins</h2>
<i>TBD</i>
<h2>The ORDER BY clause</h2>
<i>TBD</i>
<h2>Aggregate Functions And The GROUP BY and HAVING Clauses</h2>
<i>TBD</i>
<h2>Using SELECT Statements As Terms In An Expression</h2>
<i>TBD</i>
<h2>Compound SELECT Statements</h2>
<i>TBD</i>
}
puts {
<p><hr /></p>
<p><a href="index.html"><img src="/goback.jpg" border=0 />
Back to the SQLite Home Page</a>
</p>
</body></html>}
|