0000: 3c 74 69 74 6c 65 3e 54 68 65 20 53 51 4c 69 74 <title>The SQLit
0010: 65 20 42 79 74 65 63 6f 64 65 20 45 6e 67 69 6e e Bytecode Engin
0020: 65 3c 2f 74 69 74 6c 65 3e 0a 3c 74 63 6c 3e 68 e</title>.<tcl>h
0030: 64 5f 6b 65 79 77 6f 72 64 73 20 7b 76 69 72 74 d_keywords {virt
0040: 75 61 6c 20 6d 61 63 68 69 6e 65 20 69 6e 73 74 ual machine inst
0050: 72 75 63 74 69 6f 6e 73 7d 20 7b 56 44 42 45 7d ructions} {VDBE}
0060: 20 7b 76 69 72 74 75 61 6c 20 6d 61 63 68 69 6e {virtual machin
0070: 65 7d 20 5c 0a 20 20 20 20 20 20 20 20 20 7b 6f e} \. {o
0080: 70 63 6f 64 65 73 7d 20 7b 62 79 74 65 63 6f 64 pcodes} {bytecod
0090: 65 20 65 6e 67 69 6e 65 7d 20 7b 62 79 74 65 63 e engine} {bytec
00a0: 6f 64 65 73 7d 20 7b 62 79 74 65 63 6f 64 65 7d odes} {bytecode}
00b0: 3c 2f 74 63 6c 3e 0a 0a 3c 74 61 62 6c 65 5f 6f </tcl>..<table_o
00c0: 66 5f 63 6f 6e 74 65 6e 74 73 3e 0a 0a 3c 68 31 f_contents>..<h1
00d0: 3e 45 78 65 63 75 74 69 76 65 20 53 75 6d 6d 61 >Executive Summa
00e0: 72 79 3c 2f 68 31 3e 0a 0a 3c 70 3e 53 51 4c 69 ry</h1>..<p>SQLi
00f0: 74 65 20 77 6f 72 6b 73 20 62 79 20 74 72 61 6e te works by tran
0100: 73 6c 61 74 69 6e 67 20 53 51 4c 20 73 74 61 74 slating SQL stat
0110: 65 6d 65 6e 74 73 20 69 6e 74 6f 20 62 79 74 65 ements into byte
0120: 63 6f 64 65 20 61 6e 64 0a 74 68 65 6e 20 72 75 code and.then ru
0130: 6e 6e 69 6e 67 20 74 68 61 74 20 62 79 74 65 63 nning that bytec
0140: 6f 64 65 20 69 6e 20 61 20 76 69 72 74 75 61 6c ode in a virtual
0150: 20 6d 61 63 68 69 6e 65 2e 20 20 54 68 69 73 20 machine. This
0160: 64 6f 63 75 6d 65 6e 74 0a 64 65 73 63 72 69 62 document.describ
0170: 65 73 20 68 6f 77 20 68 6f 77 20 74 68 65 20 62 es how how the b
0180: 79 74 65 63 6f 64 65 20 65 6e 67 69 6e 65 20 77 ytecode engine w
0190: 6f 72 6b 73 2e 0a 0a 3c 70 3e 54 68 69 73 20 64 orks...<p>This d
01a0: 6f 63 75 6d 65 6e 74 20 64 65 73 63 72 69 62 65 ocument describe
01b0: 73 20 53 51 4c 69 74 65 20 69 6e 74 65 72 6e 61 s SQLite interna
01c0: 6c 73 2e 20 20 54 68 65 20 69 6e 66 6f 72 6d 61 ls. The informa
01d0: 74 69 6f 6e 20 70 72 6f 76 69 64 65 64 0a 68 65 tion provided.he
01e0: 72 65 20 69 73 20 6e 6f 74 20 6e 65 65 64 65 64 re is not needed
01f0: 20 66 6f 72 20 72 6f 75 74 69 6e 65 20 61 70 70 for routine app
0200: 6c 69 63 61 74 69 6f 6e 20 64 65 76 65 6c 6f 70 lication develop
0210: 6d 65 6e 74 20 75 73 69 6e 67 20 53 51 4c 69 74 ment using SQLit
0220: 65 2e 0a 54 68 69 73 20 64 6f 63 75 6d 65 6e 74 e..This document
0230: 20 69 73 20 69 6e 74 65 6e 64 65 64 20 66 6f 72 is intended for
0240: 20 70 65 6f 70 6c 65 20 77 68 6f 20 77 61 6e 74 people who want
0250: 20 74 6f 20 64 65 6c 76 65 20 6d 6f 72 65 20 64 to delve more d
0260: 65 65 70 6c 79 20 69 6e 74 6f 0a 74 68 65 20 69 eeply into.the i
0270: 6e 74 65 72 6e 61 6c 20 6f 70 65 72 61 74 69 6f nternal operatio
0280: 6e 20 6f 66 20 53 51 4c 69 74 65 2e 0a 0a 3c 70 n of SQLite...<p
0290: 3e 54 68 65 20 62 79 74 65 63 6f 64 65 20 65 6e >The bytecode en
02a0: 67 69 6e 65 20 69 73 20 3c 75 3e 6e 6f 74 3c 2f gine is <u>not</
02b0: 75 3e 20 61 6e 20 41 50 49 20 6f 66 20 53 51 4c u> an API of SQL
02c0: 69 74 65 2e 20 20 44 65 74 61 69 6c 73 0a 61 62 ite. Details.ab
02d0: 6f 75 74 20 74 68 65 20 62 79 74 65 63 6f 64 65 out the bytecode
02e0: 20 65 6e 67 69 6e 65 20 63 68 61 6e 67 65 20 66 engine change f
02f0: 72 6f 6d 20 6f 6e 65 20 72 65 6c 65 61 73 65 20 rom one release
0300: 6f 66 20 53 51 4c 69 74 65 20 74 6f 20 74 68 65 of SQLite to the
0310: 20 6e 65 78 74 2e 0a 41 70 70 6c 69 63 61 74 69 next..Applicati
0320: 6f 6e 73 20 74 68 61 74 20 75 73 65 20 53 51 4c ons that use SQL
0330: 69 74 65 20 73 68 6f 75 6c 64 20 6e 6f 74 20 64 ite should not d
0340: 65 70 65 6e 64 20 6f 6e 20 61 6e 79 20 6f 66 20 epend on any of
0350: 74 68 65 20 64 65 74 61 69 6c 73 0a 66 6f 75 6e the details.foun
0360: 64 20 69 6e 20 74 68 69 73 20 64 6f 63 75 6d 65 d in this docume
0370: 6e 74 2e 0a 0a 3c 74 63 6c 3e 0a 73 65 74 20 75 nt...<tcl>.set u
0380: 75 69 64 20 7b 7d 0a 63 61 74 63 68 20 7b 0a 20 uid {}.catch {.
0390: 20 65 78 65 63 20 66 6f 73 73 69 6c 20 73 68 61 exec fossil sha
03a0: 31 73 75 6d 20 24 3a 3a 53 52 43 2f 73 72 63 2f 1sum $::SRC/src/
03b0: 76 64 62 65 2e 63 20 0a 7d 20 75 75 69 64 0a 73 vdbe.c .} uuid.s
03c0: 65 74 20 75 75 69 64 20 5b 6c 69 6e 64 65 78 20 et uuid [lindex
03d0: 24 75 75 69 64 20 30 5d 0a 73 65 74 20 66 64 20 $uuid 0].set fd
03e0: 5b 6f 70 65 6e 20 24 3a 3a 53 52 43 2f 73 72 63 [open $::SRC/src
03f0: 2f 76 64 62 65 2e 63 20 72 5d 0a 73 65 74 20 66 /vdbe.c r].set f
0400: 69 6c 65 20 5b 72 65 61 64 20 24 66 64 5d 0a 63 ile [read $fd].c
0410: 6c 6f 73 65 20 24 66 64 0a 73 65 74 20 63 75 72 lose $fd.set cur
0420: 72 65 6e 74 5f 6f 70 20 7b 7d 0a 75 6e 73 65 74 rent_op {}.unset
0430: 20 2d 6e 6f 63 6f 6d 70 6c 61 69 6e 20 4f 70 63 -nocomplain Opc
0440: 6f 64 65 0a 75 6e 73 65 74 20 2d 6e 6f 63 6f 6d ode.unset -nocom
0450: 70 6c 61 69 6e 20 4f 70 63 6f 64 65 4c 69 73 74 plain OpcodeList
0460: 0a 66 6f 72 65 61 63 68 20 6c 69 6e 65 20 5b 73 .foreach line [s
0470: 70 6c 69 74 20 24 66 69 6c 65 20 5c 6e 5d 20 7b plit $file \n] {
0480: 0a 20 20 73 65 74 20 6c 69 6e 65 20 5b 73 74 72 . set line [str
0490: 69 6e 67 20 74 72 69 6d 20 24 6c 69 6e 65 5d 0a ing trim $line].
04a0: 20 20 69 66 20 7b 5b 73 74 72 69 6e 67 20 69 6e if {[string in
04b0: 64 65 78 20 24 6c 69 6e 65 20 31 5d 21 3d 22 2a dex $line 1]!="*
04c0: 22 7d 20 7b 0a 20 20 20 20 73 65 74 20 63 75 72 "} {. set cur
04d0: 72 65 6e 74 5f 6f 70 20 7b 7d 0a 20 20 20 20 63 rent_op {}. c
04e0: 6f 6e 74 69 6e 75 65 0a 20 20 7d 0a 20 20 69 66 ontinue. }. if
04f0: 20 7b 5b 72 65 67 65 78 70 20 7b 5e 5c 2a 5c 2a {[regexp {^\*\*
0500: 20 53 79 6e 6f 70 73 69 73 3a 7d 20 24 6c 69 6e Synopsis:} $lin
0510: 65 5d 7d 20 63 6f 6e 74 69 6e 75 65 0a 20 20 69 e]} continue. i
0520: 66 20 7b 5b 72 65 67 65 78 70 20 7b 5e 2f 5c 2a f {[regexp {^/\*
0530: 20 4f 70 63 6f 64 65 3a 20 7d 20 24 6c 69 6e 65 Opcode: } $line
0540: 5d 7d 20 7b 0a 20 20 20 20 73 65 74 20 63 75 72 ]} {. set cur
0550: 72 65 6e 74 5f 6f 70 20 5b 6c 69 6e 64 65 78 20 rent_op [lindex
0560: 24 6c 69 6e 65 20 32 5d 0a 20 20 20 20 73 65 74 $line 2]. set
0570: 20 74 78 74 20 5b 6c 72 61 6e 67 65 20 24 6c 69 txt [lrange $li
0580: 6e 65 20 33 20 65 6e 64 5d 0a 20 20 20 20 72 65 ne 3 end]. re
0590: 67 73 75 62 20 2d 61 6c 6c 20 7b 3e 7d 20 24 74 gsub -all {>} $t
05a0: 78 74 20 7b 5c 26 67 74 3b 7d 20 74 78 74 0a 20 xt {\>} txt.
05b0: 20 20 20 72 65 67 73 75 62 20 2d 61 6c 6c 20 7b regsub -all {
05c0: 3c 7d 20 24 74 78 74 20 7b 5c 26 6c 74 3b 7d 20 <} $txt {\<}
05d0: 74 78 74 0a 20 20 20 20 73 65 74 20 4f 70 63 6f txt. set Opco
05e0: 64 65 28 24 63 75 72 72 65 6e 74 5f 6f 70 3a 61 de($current_op:a
05f0: 72 67 73 29 20 24 74 78 74 0a 20 20 20 20 6c 61 rgs) $txt. la
0600: 70 70 65 6e 64 20 4f 70 63 6f 64 65 4c 69 73 74 ppend OpcodeList
0610: 20 24 63 75 72 72 65 6e 74 5f 6f 70 0a 20 20 20 $current_op.
0620: 20 73 65 74 20 70 65 6e 64 20 7b 7d 0a 20 20 20 set pend {}.
0630: 20 73 65 74 20 70 73 74 61 72 74 20 7b 7d 0a 20 set pstart {}.
0640: 20 20 20 63 6f 6e 74 69 6e 75 65 0a 20 20 7d 0a continue. }.
0650: 20 20 69 66 20 7b 24 63 75 72 72 65 6e 74 5f 6f if {$current_o
0660: 70 3d 3d 22 22 7d 20 63 6f 6e 74 69 6e 75 65 0a p==""} continue.
0670: 20 20 69 66 20 7b 5b 72 65 67 65 78 70 20 7b 5e if {[regexp {^
0680: 5c 2a 2f 7d 20 24 6c 69 6e 65 5d 7d 20 7b 0a 20 \*/} $line]} {.
0690: 20 20 20 73 65 74 20 63 75 72 72 65 6e 74 5f 6f set current_o
06a0: 70 20 7b 7d 0a 20 20 20 20 63 6f 6e 74 69 6e 75 p {}. continu
06b0: 65 0a 20 20 7d 0a 20 20 73 65 74 20 6c 69 6e 65 e. }. set line
06c0: 20 5b 73 74 72 69 6e 67 20 74 72 69 6d 20 5b 73 [string trim [s
06d0: 74 72 69 6e 67 20 72 61 6e 67 65 20 24 6c 69 6e tring range $lin
06e0: 65 20 33 20 65 6e 64 5d 5d 0a 20 20 69 66 20 7b e 3 end]]. if {
06f0: 24 6c 69 6e 65 3d 3d 22 22 7d 20 7b 0a 20 20 20 $line==""} {.
0700: 20 61 70 70 65 6e 64 20 4f 70 63 6f 64 65 28 24 append Opcode($
0710: 63 75 72 72 65 6e 74 5f 6f 70 3a 74 65 78 74 29 current_op:text)
0720: 20 24 70 65 6e 64 0a 20 20 20 20 73 65 74 20 70 $pend. set p
0730: 65 6e 64 20 7b 7d 0a 20 20 20 20 73 65 74 20 70 end {}. set p
0740: 73 74 61 72 74 20 7b 3c 70 3e 7d 0a 20 20 7d 20 start {<p>}. }
0750: 65 6c 73 65 20 7b 0a 20 20 20 20 69 66 20 7b 21 else {. if {!
0760: 5b 72 65 67 65 78 70 20 7b 3c 2f 3f 28 75 6c 7c [regexp {</?(ul|
0770: 6c 69 7c 6f 6c 29 7d 20 24 6c 69 6e 65 5d 7d 20 li|ol)} $line]}
0780: 7b 0a 20 20 20 20 20 20 72 65 67 73 75 62 20 2d {. regsub -
0790: 61 6c 6c 20 7b 3e 7d 20 24 6c 69 6e 65 20 7b 5c all {>} $line {\
07a0: 26 67 74 3b 7d 20 6c 69 6e 65 0a 20 20 20 20 20 >} line.
07b0: 20 72 65 67 73 75 62 20 2d 61 6c 6c 20 7b 3c 7d regsub -all {<}
07c0: 20 24 6c 69 6e 65 20 7b 5c 26 6c 74 3b 7d 20 6c $line {\<} l
07d0: 69 6e 65 0a 20 20 20 20 7d 0a 20 20 20 20 61 70 ine. }. ap
07e0: 70 65 6e 64 20 4f 70 63 6f 64 65 28 24 63 75 72 pend Opcode($cur
07f0: 72 65 6e 74 5f 6f 70 3a 74 65 78 74 29 20 5c 6e rent_op:text) \n
0800: 24 70 73 74 61 72 74 24 6c 69 6e 65 0a 20 20 20 $pstart$line.
0810: 20 73 65 74 20 70 73 74 61 72 74 20 7b 7d 0a 20 set pstart {}.
0820: 20 20 20 73 65 74 20 70 65 6e 64 20 22 3c 2f 70 set pend "</p
0830: 3e 5c 6e 22 0a 20 20 7d 0a 7d 0a 75 6e 73 65 74 >\n". }.}.unset
0840: 20 66 69 6c 65 0a 73 65 74 20 66 64 20 5b 6f 70 file.set fd [op
0850: 65 6e 20 24 3a 3a 53 52 43 2f 56 45 52 53 49 4f en $::SRC/VERSIO
0860: 4e 20 72 5d 0a 73 65 74 20 53 51 4c 49 54 45 5f N r].set SQLITE_
0870: 56 45 52 53 49 4f 4e 20 5b 73 74 72 69 6e 67 20 VERSION [string
0880: 74 72 69 6d 20 5b 72 65 61 64 20 24 66 64 5d 5d trim [read $fd]]
0890: 0a 63 6c 6f 73 65 20 24 66 64 0a 73 65 74 20 66 .close $fd.set f
08a0: 64 20 5b 6f 70 65 6e 20 24 3a 3a 53 52 43 2f 6d d [open $::SRC/m
08b0: 61 6e 69 66 65 73 74 2e 75 75 69 64 20 72 5d 0a anifest.uuid r].
08c0: 73 65 74 20 53 51 4c 49 54 45 5f 53 48 41 31 5f set SQLITE_SHA1_
08d0: 56 45 52 53 49 4f 4e 20 5b 73 74 72 69 6e 67 20 VERSION [string
08e0: 74 72 69 6d 20 5b 72 65 61 64 20 24 66 64 5d 5d trim [read $fd]]
08f0: 0a 73 65 74 20 53 51 4c 49 54 45 5f 48 41 53 48 .set SQLITE_HASH
0900: 20 5b 73 74 72 69 6e 67 20 72 61 6e 67 65 20 24 [string range $
0910: 53 51 4c 49 54 45 5f 53 48 41 31 5f 56 45 52 53 SQLITE_SHA1_VERS
0920: 49 4f 4e 20 30 20 31 32 5d 0a 63 6c 6f 73 65 20 ION 0 12].close
0930: 24 66 64 0a 73 65 74 20 66 64 20 5b 6f 70 65 6e $fd.set fd [open
0940: 20 24 3a 3a 53 52 43 2f 6d 61 6e 69 66 65 73 74 $::SRC/manifest
0950: 20 72 5d 0a 73 65 74 20 66 69 6c 65 20 5b 72 65 r].set file [re
0960: 61 64 20 24 66 64 5d 0a 63 6c 6f 73 65 20 24 66 ad $fd].close $f
0970: 64 0a 73 65 74 20 53 51 4c 49 54 45 5f 43 4b 49 d.set SQLITE_CKI
0980: 4e 5f 44 41 54 45 20 7b 75 6e 6b 6e 6f 77 6e 7d N_DATE {unknown}
0990: 0a 72 65 67 65 78 70 20 7b 5c 6e 44 20 28 5c 64 .regexp {\nD (\d
09a0: 5c 64 5c 64 5c 64 2d 5c 64 5c 64 2d 5c 64 5c 64 \d\d\d-\d\d-\d\d
09b0: 29 7d 20 24 66 69 6c 65 20 61 6c 6c 20 53 51 4c )} $file all SQL
09c0: 49 54 45 5f 43 4b 49 4e 5f 44 41 54 45 0a 75 6e ITE_CKIN_DATE.un
09d0: 73 65 74 20 66 69 6c 65 0a 0a 23 20 53 63 61 6e set file..# Scan
09e0: 20 24 74 78 74 20 61 6e 64 20 72 65 70 6c 61 63 $txt and replac
09f0: 65 20 65 76 65 72 79 20 6f 70 63 6f 64 65 20 6e e every opcode n
0a00: 61 6d 65 20 77 69 74 68 20 61 20 6c 69 6e 6b 20 ame with a link
0a10: 74 6f 20 69 74 73 20 64 6f 63 75 6d 65 6e 74 61 to its documenta
0a20: 74 69 6f 6e 0a 23 0a 70 72 6f 63 20 4c 69 6e 6b tion.#.proc Link
0a30: 4f 70 63 6f 64 65 4e 61 6d 65 73 20 7b 74 78 74 OpcodeNames {txt
0a40: 7d 20 7b 0a 20 20 67 6c 6f 62 61 6c 20 4f 70 63 } {. global Opc
0a50: 6f 64 65 0a 20 20 73 65 74 20 6f 75 74 20 7b 7d ode. set out {}
0a60: 0a 20 20 77 68 69 6c 65 20 7b 5b 72 65 67 65 78 . while {[regex
0a70: 70 20 7b 5e 28 2e 2a 3f 29 28 4f 50 5f 5b 41 2d p {^(.*?)(OP_[A-
0a80: 5a 5d 5b 61 2d 7a 5d 29 5c 79 28 2e 2a 29 24 7d Z][a-z])\y(.*)$}
0a90: 20 24 74 78 74 20 5c 0a 20 20 20 20 20 20 20 20 $txt \.
0aa0: 20 20 20 20 20 61 6c 6c 20 70 72 65 20 6f 70 20 all pre op
0ab0: 74 61 69 6c 5d 20 7c 7c 0a 20 20 20 20 20 20 20 tail] ||.
0ac0: 20 5b 72 65 67 65 78 70 20 7b 5e 28 2e 2a 3f 29 [regexp {^(.*?)
0ad0: 5c 79 28 28 4f 50 5f 29 3f 5b 41 2d 5a 5d 5b 41 \y((OP_)?[A-Z][A
0ae0: 2d 5a 61 2d 7a 5d 5b 41 2d 5a 61 2d 7a 30 2d 39 -Za-z][A-Za-z0-9
0af0: 5d 2b 29 5c 79 28 2e 2a 29 24 7d 20 24 74 78 74 ]+)\y(.*)$} $txt
0b00: 20 5c 0a 20 20 20 20 20 20 20 20 20 20 20 20 20 \.
0b10: 61 6c 6c 20 70 72 65 20 6f 70 20 6f 70 78 20 74 all pre op opx t
0b20: 61 69 6c 5d 7d 20 7b 0a 20 20 20 20 68 64 5f 72 ail]} {. hd_r
0b30: 65 73 6f 6c 76 65 20 24 70 72 65 0a 20 20 20 20 esolve $pre.
0b40: 69 66 20 7b 28 24 70 72 65 3d 3d 22 22 20 7c 7c if {($pre=="" ||
0b50: 20 5b 72 65 67 65 78 70 20 7b 3e 20 2a 24 7d 20 [regexp {> *$}
0b60: 24 70 72 65 5d 29 20 26 26 20 21 5b 72 65 67 65 $pre]) && ![rege
0b70: 78 70 20 7b 5e 4f 50 5f 7d 20 24 6f 70 5d 0a 20 xp {^OP_} $op].
0b80: 20 20 20 20 20 20 20 20 7c 7c 20 5b 72 65 67 65 || [rege
0b90: 78 70 20 7b 5e 6f 62 6a 65 63 74 7d 20 5b 73 74 xp {^object} [st
0ba0: 72 69 6e 67 20 74 72 69 6d 20 24 74 61 69 6c 5d ring trim $tail]
0bb0: 5d 7d 20 7b 0a 20 20 20 20 20 20 68 64 5f 70 75 ]} {. hd_pu
0bc0: 74 73 20 24 6f 70 0a 20 20 20 20 7d 20 65 6c 73 ts $op. } els
0bd0: 65 20 7b 0a 20 20 20 20 20 20 72 65 67 73 75 62 e {. regsub
0be0: 20 7b 5e 4f 50 5f 7d 20 24 6f 70 20 7b 7d 20 6b {^OP_} $op {} k
0bf0: 65 79 0a 20 20 20 20 20 20 69 66 20 7b 5b 69 6e ey. if {[in
0c00: 66 6f 20 65 78 69 73 74 73 20 4f 70 63 6f 64 65 fo exists Opcode
0c10: 28 24 6b 65 79 3a 74 65 78 74 29 5d 7d 20 7b 0a ($key:text)]} {.
0c20: 20 20 20 20 20 20 20 20 68 64 5f 70 75 74 73 20 hd_puts
0c30: 22 3c 61 20 68 72 65 66 3d 5c 22 6f 70 63 6f 64 "<a href=\"opcod
0c40: 65 2e 68 74 6d 6c 23 24 6b 65 79 5c 22 3e 24 6b e.html#$key\">$k
0c50: 65 79 3c 2f 61 3e 22 0a 20 20 20 20 20 20 7d 20 ey</a>". }
0c60: 65 6c 73 65 20 7b 0a 20 20 20 20 20 20 20 20 68 else {. h
0c70: 64 5f 70 75 74 73 20 24 6f 70 0a 20 20 20 20 20 d_puts $op.
0c80: 20 7d 0a 20 20 20 20 7d 0a 20 20 20 20 73 65 74 }. }. set
0c90: 20 74 78 74 20 24 74 61 69 6c 0a 20 20 7d 0a 20 txt $tail. }.
0ca0: 20 68 64 5f 72 65 73 6f 6c 76 65 20 24 74 78 74 hd_resolve $txt
0cb0: 0a 7d 0a 3c 2f 74 63 6c 3e 0a 0a 3c 68 31 3e 49 .}.</tcl>..<h1>I
0cc0: 6e 74 72 6f 64 75 63 74 69 6f 6e 3c 2f 68 31 3e ntroduction</h1>
0cd0: 0a 0a 3c 70 3e 53 51 4c 69 74 65 20 77 6f 72 6b ..<p>SQLite work
0ce0: 73 20 62 79 20 74 72 61 6e 73 6c 61 74 69 6e 67 s by translating
0cf0: 20 65 61 63 68 20 53 51 4c 20 73 74 61 74 65 6d each SQL statem
0d00: 65 6e 74 20 69 6e 74 6f 20 62 79 74 65 63 6f 64 ent into bytecod
0d10: 65 20 61 6e 64 0a 74 68 65 6e 20 72 75 6e 6e 69 e and.then runni
0d20: 6e 67 20 74 68 61 74 20 62 79 74 65 63 6f 64 65 ng that bytecode
0d30: 2e 0a 41 20 5b 70 72 65 70 61 72 65 64 20 73 74 ..A [prepared st
0d40: 61 74 65 6d 65 6e 74 5d 20 69 6e 20 53 51 4c 69 atement] in SQLi
0d50: 74 65 20 69 73 20 6d 6f 73 74 6c 79 20 6a 75 73 te is mostly jus
0d60: 74 20 74 68 65 20 62 79 74 65 63 6f 64 65 20 6e t the bytecode n
0d70: 65 65 64 65 64 20 74 6f 0a 69 6d 70 6c 65 6d 65 eeded to.impleme
0d80: 6e 74 20 74 68 65 20 63 6f 72 72 65 73 70 6f 6e nt the correspon
0d90: 64 69 6e 67 20 53 51 4c 2e 20 20 54 68 65 20 5b ding SQL. The [
0da0: 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 5f sqlite3_prepare_
0db0: 76 32 28 29 5d 20 69 6e 74 65 72 66 61 63 65 0a v2()] interface.
0dc0: 69 73 20 61 20 63 6f 6d 70 69 6c 65 72 20 74 68 is a compiler th
0dd0: 61 74 20 74 72 61 6e 73 6c 61 74 65 73 20 53 51 at translates SQ
0de0: 4c 20 69 6e 74 6f 20 62 79 74 65 63 6f 64 65 2e L into bytecode.
0df0: 0a 54 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 74 .The [sqlite3_st
0e00: 65 70 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 ep()] interface
0e10: 69 73 20 74 68 65 20 76 69 72 74 75 61 6c 20 6d is the virtual m
0e20: 61 63 68 69 6e 65 20 74 68 61 74 20 72 75 6e 73 achine that runs
0e30: 20 74 68 65 0a 62 79 74 65 63 6f 64 65 20 63 6f the.bytecode co
0e40: 6e 74 61 69 6e 65 64 20 77 69 74 68 69 6e 20 74 ntained within t
0e50: 68 65 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 he [prepared sta
0e60: 74 65 6d 65 6e 74 5d 2e 0a 0a 3c 70 3e 54 68 65 tement]...<p>The
0e70: 20 62 79 74 65 63 6f 64 65 20 76 69 72 74 75 61 bytecode virtua
0e80: 6c 20 6d 61 63 68 69 6e 65 20 69 73 20 74 68 65 l machine is the
0e90: 20 68 65 61 72 74 20 6f 66 20 53 51 4c 69 74 65 heart of SQLite
0ea0: 2e 0a 50 72 6f 67 72 61 6d 6d 65 72 73 20 77 68 ..Programmers wh
0eb0: 6f 20 77 61 6e 74 20 74 6f 20 75 6e 64 65 72 73 o want to unders
0ec0: 74 61 6e 64 20 68 6f 77 20 53 51 4c 69 74 65 20 tand how SQLite
0ed0: 6f 70 65 72 61 74 65 73 20 69 6e 74 65 72 6e 61 operates interna
0ee0: 6c 6c 79 0a 6d 75 73 74 20 62 65 20 66 61 6d 69 lly.must be fami
0ef0: 6c 69 61 72 20 77 69 74 68 20 74 68 65 20 62 79 liar with the by
0f00: 74 65 63 6f 64 65 20 65 6e 67 69 6e 65 2e 0a 0a tecode engine...
0f10: 3c 70 3e 48 69 73 74 6f 72 69 63 61 6c 6c 79 2c <p>Historically,
0f20: 20 74 68 65 20 62 79 74 65 63 6f 64 65 20 65 6e the bytecode en
0f30: 67 69 6e 65 20 69 6e 20 53 51 4c 69 74 65 20 69 gine in SQLite i
0f40: 73 20 63 61 6c 6c 65 64 20 74 68 65 0a 22 56 69 s called the."Vi
0f50: 72 74 75 61 6c 20 44 61 74 61 42 61 73 65 20 45 rtual DataBase E
0f60: 6e 67 69 6e 65 22 20 6f 72 20 22 56 44 42 45 22 ngine" or "VDBE"
0f70: 2e 20 20 54 68 69 73 20 77 65 62 73 69 74 65 20 . This website
0f80: 75 73 65 73 20 74 68 65 20 74 65 72 6d 73 0a 22 uses the terms."
0f90: 62 79 74 65 63 6f 64 65 20 65 6e 67 69 6e 65 22 bytecode engine"
0fa0: 2c 20 22 56 44 42 45 22 2c 20 22 76 69 72 74 75 , "VDBE", "virtu
0fb0: 61 6c 20 6d 61 63 68 69 6e 65 22 2c 20 61 6e 64 al machine", and
0fc0: 20 22 62 79 74 65 63 6f 64 65 20 76 69 72 74 75 "bytecode virtu
0fd0: 61 6c 0a 6d 61 63 68 69 6e 65 22 20 69 6e 74 65 al.machine" inte
0fe0: 72 63 68 61 6e 67 65 61 62 6c 79 2c 20 61 73 20 rchangeably, as
0ff0: 74 68 65 79 20 61 6c 6c 20 6d 65 61 6e 20 74 68 they all mean th
1000: 65 20 73 61 6d 65 20 74 68 69 6e 67 2e 0a 0a 3c e same thing...<
1010: 70 3e 0a 54 68 69 73 20 61 72 74 69 63 6c 65 20 p>.This article
1020: 61 6c 73 6f 20 75 73 65 73 20 74 68 65 20 74 65 also uses the te
1030: 72 6d 73 20 22 62 79 74 65 63 6f 64 65 20 70 72 rms "bytecode pr
1040: 6f 67 72 61 6d 22 20 61 6e 64 0a 22 70 72 65 70 ogram" and."prep
1050: 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 22 20 ared statement"
1060: 69 6e 74 65 72 63 68 61 6e 67 65 61 62 6c 79 2c interchangeably,
1070: 20 61 73 20 74 68 65 79 20 61 72 65 20 6d 6f 73 as they are mos
1080: 74 6c 79 20 74 68 65 20 73 61 6d 65 20 74 68 69 tly the same thi
1090: 6e 67 2e 0a 0a 3c 68 32 3e 56 44 42 45 20 53 6f ng...<h2>VDBE So
10a0: 75 72 63 65 20 43 6f 64 65 3c 2f 68 32 3e 0a 0a urce Code</h2>..
10b0: 3c 70 3e 54 68 65 20 73 6f 75 72 63 65 20 63 6f <p>The source co
10c0: 64 65 20 74 6f 20 74 68 65 20 62 79 74 65 63 6f de to the byteco
10d0: 64 65 20 65 6e 67 69 6e 65 20 69 73 20 69 6e 20 de engine is in
10e0: 74 68 65 20 0a 5b 68 74 74 70 3a 2f 2f 77 77 77 the .[http://www
10f0: 2e 73 71 6c 69 74 65 2e 6f 72 67 2f 73 72 63 2f .sqlite.org/src/
1100: 66 69 6e 66 6f 3f 6e 61 6d 65 3d 73 72 63 2f 76 finfo?name=src/v
1110: 64 62 65 2e 63 20 7c 20 76 64 62 65 2e 63 5d 20 dbe.c | vdbe.c]
1120: 73 6f 75 72 63 65 0a 66 69 6c 65 2e 20 20 54 68 source.file. Th
1130: 65 20 5b 6f 70 63 6f 64 65 20 64 65 66 69 6e 69 e [opcode defini
1140: 74 69 6f 6e 73 5d 20 69 6e 20 74 68 69 73 20 64 tions] in this d
1150: 6f 63 75 6d 65 6e 74 20 61 72 65 20 64 65 72 69 ocument are deri
1160: 76 65 64 0a 66 72 6f 6d 20 63 6f 6d 6d 65 6e 74 ved.from comment
1170: 73 20 69 6e 20 74 68 61 74 20 73 6f 75 72 63 65 s in that source
1180: 20 66 69 6c 65 2e 20 54 68 65 20 0a 73 6f 75 72 file. The .sour
1190: 63 65 20 63 6f 64 65 20 63 6f 6d 6d 65 6e 74 73 ce code comments
11a0: 20 61 72 65 20 74 68 65 20 63 61 6e 6f 6e 69 63 are the canonic
11b0: 61 6c 20 73 6f 75 72 63 65 20 6f 66 20 69 6e 66 al source of inf
11c0: 6f 72 6d 61 74 69 6f 6e 0a 61 62 6f 75 74 20 74 ormation.about t
11d0: 68 65 20 62 79 74 65 63 6f 64 65 20 65 6e 67 69 he bytecode engi
11e0: 6e 65 2e 20 20 57 68 65 6e 20 69 6e 20 64 6f 75 ne. When in dou
11f0: 62 74 2c 20 72 65 66 65 72 20 74 6f 20 74 68 65 bt, refer to the
1200: 20 73 6f 75 72 63 65 20 63 6f 64 65 2e 3c 2f 70 source code.</p
1210: 3e 0a 0a 3c 70 3e 49 6e 20 61 64 64 69 74 69 6f >..<p>In additio
1220: 6e 20 74 6f 20 74 68 65 20 70 72 69 6d 61 72 79 n to the primary
1230: 20 76 64 62 65 2e 63 20 73 6f 75 72 63 65 20 63 vdbe.c source c
1240: 6f 64 65 20 66 69 6c 65 2c 20 74 68 65 72 65 20 ode file, there
1250: 61 72 65 20 0a 6f 74 68 65 72 20 68 65 6c 70 65 are .other helpe
1260: 72 20 63 6f 64 65 20 66 69 6c 65 73 20 69 6e 20 r code files in
1270: 74 68 65 20 73 6f 75 72 63 65 20 74 72 65 65 2c the source tree,
1280: 20 61 6c 6c 20 6f 66 20 77 68 6f 73 65 20 6e 61 all of whose na
1290: 6d 65 73 0a 62 65 67 69 6e 20 77 69 74 68 20 22 mes.begin with "
12a0: 76 64 62 65 22 20 2d 20 73 68 6f 72 74 20 66 6f vdbe" - short fo
12b0: 72 20 22 56 69 72 74 75 61 6c 20 44 61 74 61 42 r "Virtual DataB
12c0: 61 73 65 20 45 6e 67 69 6e 65 22 2e 0a 0a 3c 70 ase Engine"...<p
12d0: 3e 52 65 6d 65 6d 62 65 72 20 74 68 61 74 20 74 >Remember that t
12e0: 68 65 20 6e 61 6d 65 73 20 61 6e 64 20 6d 65 61 he names and mea
12f0: 6e 69 6e 67 73 20 6f 66 20 6f 70 63 6f 64 65 73 nings of opcodes
1300: 20 6f 66 74 65 6e 20 63 68 61 6e 67 65 20 66 72 often change fr
1310: 6f 6d 0a 6f 6e 65 20 72 65 6c 65 61 73 65 20 6f om.one release o
1320: 66 20 53 51 4c 69 74 65 20 74 6f 20 74 68 65 20 f SQLite to the
1330: 6e 65 78 74 2e 20 20 53 6f 20 69 66 20 79 6f 75 next. So if you
1340: 20 61 72 65 20 73 74 75 64 79 69 6e 67 20 74 68 are studying th
1350: 65 20 5b 45 58 50 4c 41 49 4e 5d 0a 6f 75 74 70 e [EXPLAIN].outp
1360: 75 74 20 66 72 6f 6d 20 53 51 4c 69 74 65 2c 20 ut from SQLite,
1370: 79 6f 75 20 73 68 6f 75 6c 64 20 72 65 66 65 72 you should refer
1380: 65 6e 63 65 20 74 68 65 20 76 65 72 73 69 6f 6e ence the version
1390: 20 6f 66 20 74 68 69 73 20 64 6f 63 75 6d 65 6e of this documen
13a0: 74 0a 28 6f 72 20 74 68 65 20 76 64 62 65 2e 63 t.(or the vdbe.c
13b0: 20 73 6f 75 72 63 65 20 63 6f 64 65 29 0a 74 68 source code).th
13c0: 61 74 20 63 6f 72 72 65 73 70 6f 6e 64 73 20 74 at corresponds t
13d0: 6f 20 74 68 65 20 76 65 72 73 69 6f 6e 20 6f 66 o the version of
13e0: 20 53 51 4c 69 74 65 20 74 68 61 74 20 72 61 6e SQLite that ran
13f0: 20 74 68 65 20 5b 45 58 50 4c 41 49 4e 5d 2e 0a the [EXPLAIN]..
1400: 4f 74 68 65 72 77 69 73 65 2c 20 74 68 65 20 64 Otherwise, the d
1410: 65 73 63 72 69 70 74 69 6f 6e 20 6f 66 20 74 68 escription of th
1420: 65 20 6f 70 63 6f 64 65 73 20 6d 61 79 20 6e 6f e opcodes may no
1430: 74 20 62 65 20 61 63 63 75 72 61 74 65 2e 0a 54 t be accurate..T
1440: 68 69 73 20 64 6f 63 75 6d 65 6e 74 20 69 73 20 his document is
1450: 64 65 72 69 76 65 64 20 66 72 6f 6d 20 53 51 4c derived from SQL
1460: 69 74 65 0a 3c 74 63 6c 3e 0a 68 64 5f 70 75 74 ite.<tcl>.hd_put
1470: 73 20 22 20 76 65 72 73 69 6f 6e 20 24 53 51 4c s " version $SQL
1480: 49 54 45 5f 56 45 52 53 49 4f 4e 20 63 68 65 63 ITE_VERSION chec
1490: 6b 2d 69 6e 5c 6e 22 0a 73 65 74 20 75 72 6c 20 k-in\n".set url
14a0: 68 74 74 70 73 3a 2f 2f 77 77 77 2e 73 71 6c 69 https://www.sqli
14b0: 74 65 2e 6f 72 67 2f 73 72 63 2f 74 69 6d 65 6c te.org/src/timel
14c0: 69 6e 65 3f 63 3d 24 53 51 4c 49 54 45 5f 48 41 ine?c=$SQLITE_HA
14d0: 53 48 0a 68 64 5f 70 75 74 73 20 22 3c 61 20 68 SH.hd_puts "<a h
14e0: 72 65 66 3d 27 24 75 72 6c 27 3e 24 53 51 4c 49 ref='$url'>$SQLI
14f0: 54 45 5f 48 41 53 48 3c 2f 61 3e 20 64 61 74 65 TE_HASH</a> date
1500: 64 20 24 53 51 4c 49 54 45 5f 43 4b 49 4e 5f 44 d $SQLITE_CKIN_D
1510: 41 54 45 2e 5c 6e 5c 6e 22 0a 3c 2f 74 63 6c 3e ATE.\n\n".</tcl>
1520: 0a 0a 0a 3c 68 32 3e 49 6e 73 74 72 75 63 74 69 ...<h2>Instructi
1530: 6f 6e 20 46 6f 72 6d 61 74 3c 2f 68 32 3e 0a 0a on Format</h2>..
1540: 3c 74 63 6c 3e 0a 4c 69 6e 6b 4f 70 63 6f 64 65 <tcl>.LinkOpcode
1550: 4e 61 6d 65 73 20 7b 0a 3c 70 3e 41 20 62 79 74 Names {.<p>A byt
1560: 65 63 6f 64 65 64 20 70 72 6f 67 72 61 6d 20 69 ecoded program i
1570: 6e 20 53 51 4c 69 74 65 20 63 6f 6e 73 69 73 74 n SQLite consist
1580: 73 20 6f 66 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 s of one or more
1590: 20 69 6e 73 74 72 75 63 74 69 6f 6e 73 2e 0a 45 instructions..E
15a0: 61 63 68 20 69 6e 73 74 72 75 63 74 69 6f 6e 20 ach instruction
15b0: 68 61 73 20 61 6e 20 6f 70 63 6f 64 65 20 61 6e has an opcode an
15c0: 64 0a 66 69 76 65 20 6f 70 65 72 61 6e 64 73 20 d.five operands
15d0: 6e 61 6d 65 64 20 50 31 2c 20 50 32 20 20 50 33 named P1, P2 P3
15e0: 2c 20 50 34 2c 20 61 6e 64 20 50 35 2e 20 20 54 , P4, and P5. T
15f0: 68 65 20 50 31 2c 20 50 32 2c 20 61 6e 64 20 50 he P1, P2, and P
1600: 33 20 0a 6f 70 65 72 61 6e 64 73 20 61 72 65 20 3 .operands are
1610: 33 32 2d 62 69 74 20 73 69 67 6e 65 64 20 69 6e 32-bit signed in
1620: 74 65 67 65 72 73 2e 20 20 54 68 65 73 65 20 6f tegers. These o
1630: 70 65 72 61 6e 64 73 20 6f 66 74 65 6e 20 72 65 perands often re
1640: 66 65 72 20 74 6f 20 0a 72 65 67 69 73 74 65 72 fer to .register
1650: 73 2e 20 20 46 6f 72 20 69 6e 73 74 72 75 63 74 s. For instruct
1660: 69 6f 6e 73 20 74 68 61 74 20 6f 70 65 72 61 74 ions that operat
1670: 65 20 6f 6e 20 62 2d 74 72 65 65 20 63 75 72 73 e on b-tree curs
1680: 6f 72 73 2c 0a 74 68 65 20 50 31 20 6f 70 65 72 ors,.the P1 oper
1690: 61 6e 64 20 69 73 20 75 73 75 61 6c 6c 79 20 74 and is usually t
16a0: 68 65 20 63 75 72 73 6f 72 20 6e 75 6d 62 65 72 he cursor number
16b0: 2e 0a 46 6f 72 20 6a 75 6d 70 20 69 6e 73 74 72 ..For jump instr
16c0: 75 63 74 69 6f 6e 73 2c 20 50 32 20 69 73 20 75 uctions, P2 is u
16d0: 73 75 61 6c 6c 79 20 74 68 65 20 6a 75 6d 70 20 sually the jump
16e0: 64 65 73 74 69 6e 61 74 69 6f 6e 2e 0a 50 34 20 destination..P4
16f0: 6d 61 79 20 62 65 20 61 20 33 32 2d 62 69 74 20 may be a 32-bit
1700: 73 69 67 6e 65 64 20 69 6e 74 65 67 65 72 2c 20 signed integer,
1710: 61 20 36 34 2d 62 69 74 20 73 69 67 6e 65 64 20 a 64-bit signed
1720: 69 6e 74 65 67 65 72 2c 20 61 0a 36 34 2d 62 69 integer, a.64-bi
1730: 74 20 66 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74 t floating point
1740: 20 76 61 6c 75 65 2c 20 61 20 73 74 72 69 6e 67 value, a string
1750: 20 6c 69 74 65 72 61 6c 2c 20 61 20 42 6c 6f 62 literal, a Blob
1760: 20 6c 69 74 65 72 61 6c 2c 0a 61 20 70 6f 69 6e literal,.a poin
1770: 74 65 72 20 74 6f 20 61 20 63 6f 6c 6c 61 74 69 ter to a collati
1780: 6e 67 20 73 65 71 75 65 6e 63 65 20 63 6f 6d 70 ng sequence comp
1790: 61 72 69 73 6f 6e 20 66 75 6e 63 74 69 6f 6e 2c arison function,
17a0: 20 6f 72 20 61 0a 70 6f 69 6e 74 65 72 20 74 6f or a.pointer to
17b0: 20 74 68 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74 the implementat
17c0: 69 6f 6e 20 6f 66 20 61 6e 20 61 70 70 6c 69 63 ion of an applic
17d0: 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 53 51 ation-defined SQ
17e0: 4c 0a 66 75 6e 63 74 69 6f 6e 2c 20 6f 72 20 76 L.function, or v
17f0: 61 72 69 6f 75 73 20 6f 74 68 65 72 20 74 68 69 arious other thi
1800: 6e 67 73 2e 20 20 50 35 20 69 73 20 61 6e 20 31 ngs. P5 is an 1
1810: 36 2d 62 69 74 20 75 6e 73 69 67 6e 65 64 20 69 6-bit unsigned i
1820: 6e 74 65 67 65 72 0a 6e 6f 72 6d 61 6c 6c 79 20 nteger.normally
1830: 75 73 65 64 20 74 6f 20 68 6f 6c 64 20 66 6c 61 used to hold fla
1840: 67 73 2e 20 20 42 69 74 73 20 6f 66 20 74 68 65 gs. Bits of the
1850: 20 50 35 20 66 6c 61 67 20 63 61 6e 20 73 6f 6d P5 flag can som
1860: 65 74 69 6d 65 73 20 61 66 66 65 63 74 0a 74 68 etimes affect.th
1870: 65 20 6f 70 63 6f 64 65 20 69 6e 20 73 75 62 74 e opcode in subt
1880: 6c 65 20 77 61 79 73 2e 20 20 46 6f 72 20 65 78 le ways. For ex
1890: 61 6d 70 6c 65 2c 20 69 66 20 74 68 65 20 0a 53 ample, if the .S
18a0: 51 4c 49 54 45 5f 4e 55 4c 4c 45 51 20 28 30 78 QLITE_NULLEQ (0x
18b0: 30 30 38 30 29 20 62 69 74 20 6f 66 20 74 68 65 0080) bit of the
18c0: 20 50 35 20 6f 70 65 72 61 6e 64 0a 69 73 20 73 P5 operand.is s
18d0: 65 74 20 6f 6e 20 74 68 65 20 4f 50 5f 45 71 20 et on the OP_Eq
18e0: 6f 70 63 6f 64 65 2c 20 74 68 65 6e 20 74 68 65 opcode, then the
18f0: 20 4e 55 4c 4c 20 76 61 6c 75 65 73 20 63 6f 6d NULL values com
1900: 70 61 72 65 0a 65 71 75 61 6c 20 74 6f 20 6f 6e pare.equal to on
1910: 65 20 61 6e 6f 74 68 65 72 2e 20 20 4f 74 68 65 e another. Othe
1920: 72 77 69 73 65 20 4e 55 4c 4c 20 76 61 6c 75 65 rwise NULL value
1930: 73 20 63 6f 6d 70 61 72 65 20 64 69 66 66 65 72 s compare differ
1940: 65 6e 74 0a 66 72 6f 6d 20 6f 6e 65 20 61 6e 6f ent.from one ano
1950: 74 68 65 72 2e 0a 7d 0a 3c 2f 74 63 6c 3e 0a 0a ther..}.</tcl>..
1960: 3c 70 3e 53 6f 6d 65 20 6f 70 63 6f 64 65 73 20 <p>Some opcodes
1970: 75 73 65 20 61 6c 6c 20 66 69 76 65 20 6f 70 65 use all five ope
1980: 72 61 6e 64 73 2e 20 20 53 6f 6d 65 20 6f 70 63 rands. Some opc
1990: 6f 64 65 73 20 75 73 65 0a 6f 6e 65 20 6f 72 20 odes use.one or
19a0: 74 77 6f 2e 20 20 53 6f 6d 65 20 6f 70 63 6f 64 two. Some opcod
19b0: 65 73 20 75 73 65 20 6e 6f 6e 65 20 6f 66 20 74 es use none of t
19c0: 68 65 20 6f 70 65 72 61 6e 64 73 2e 3c 70 3e 0a he operands.<p>.
19d0: 0a 3c 74 63 6c 3e 0a 4c 69 6e 6b 4f 70 63 6f 64 .<tcl>.LinkOpcod
19e0: 65 4e 61 6d 65 73 20 7b 0a 3c 70 3e 54 68 65 20 eNames {.<p>The
19f0: 62 79 74 65 63 6f 64 65 20 65 6e 67 69 6e 65 20 bytecode engine
1a00: 62 65 67 69 6e 73 20 65 78 65 63 75 74 69 6f 6e begins execution
1a10: 20 6f 6e 20 69 6e 73 74 72 75 63 74 69 6f 6e 20 on instruction
1a20: 6e 75 6d 62 65 72 20 30 2e 0a 45 78 65 63 75 74 number 0..Execut
1a30: 69 6f 6e 20 63 6f 6e 74 69 6e 75 65 73 20 75 6e ion continues un
1a40: 74 69 6c 20 61 20 4f 50 5f 48 61 6c 74 20 69 6e til a OP_Halt in
1a50: 73 74 72 75 63 74 69 6f 6e 20 69 73 20 73 65 65 struction is see
1a60: 6e 2c 20 6f 72 20 75 6e 74 69 6c 0a 74 68 65 20 n, or until.the
1a70: 70 72 6f 67 72 61 6d 20 63 6f 75 6e 74 65 72 20 program counter
1a80: 62 65 63 6f 6d 65 73 20 67 72 65 61 74 65 72 20 becomes greater
1a90: 74 68 61 6e 20 74 68 65 20 61 64 64 72 65 73 73 than the address
1aa0: 20 6f 66 0a 6c 61 73 74 20 69 6e 73 74 72 75 63 of.last instruc
1ab0: 74 69 6f 6e 2c 20 6f 72 20 75 6e 74 69 6c 20 74 tion, or until t
1ac0: 68 65 72 65 20 69 73 20 61 6e 20 65 72 72 6f 72 here is an error
1ad0: 2e 0a 57 68 65 6e 20 74 68 65 20 62 79 74 65 63 ..When the bytec
1ae0: 6f 64 65 20 65 6e 67 69 6e 65 20 68 61 6c 74 73 ode engine halts
1af0: 2c 20 61 6c 6c 20 6d 65 6d 6f 72 79 0a 74 68 61 , all memory.tha
1b00: 74 20 69 74 20 61 6c 6c 6f 63 61 74 65 64 20 69 t it allocated i
1b10: 73 20 72 65 6c 65 61 73 65 64 20 61 6e 64 20 61 s released and a
1b20: 6c 6c 20 64 61 74 61 62 61 73 65 20 63 75 72 73 ll database curs
1b30: 6f 72 73 20 69 74 20 6d 61 79 0a 68 61 76 65 20 ors it may.have
1b40: 68 61 64 20 6f 70 65 6e 20 61 72 65 20 63 6c 6f had open are clo
1b50: 73 65 64 2e 20 20 49 66 20 74 68 65 20 65 78 65 sed. If the exe
1b60: 63 75 74 69 6f 6e 20 73 74 6f 70 70 65 64 20 64 cution stopped d
1b70: 75 65 20 74 6f 20 61 6e 0a 65 72 72 6f 72 2c 20 ue to an.error,
1b80: 61 6e 79 20 70 65 6e 64 69 6e 67 20 74 72 61 6e any pending tran
1b90: 73 61 63 74 69 6f 6e 73 20 61 72 65 20 74 65 72 sactions are ter
1ba0: 6d 69 6e 61 74 65 64 20 61 6e 64 20 63 68 61 6e minated and chan
1bb0: 67 65 73 20 6d 61 64 65 0a 74 6f 20 74 68 65 20 ges made.to the
1bc0: 64 61 74 61 62 61 73 65 20 61 72 65 20 72 6f 6c database are rol
1bd0: 6c 65 64 20 62 61 63 6b 2e 3c 2f 70 3e 0a 7d 0a led back.</p>.}.
1be0: 3c 2f 74 63 6c 3e 0a 0a 3c 74 63 6c 3e 0a 4c 69 </tcl>..<tcl>.Li
1bf0: 6e 6b 4f 70 63 6f 64 65 4e 61 6d 65 73 20 7b 0a nkOpcodeNames {.
1c00: 3c 70 3e 54 68 65 20 4f 50 5f 52 65 73 75 6c 74 <p>The OP_Result
1c10: 52 6f 77 20 6f 70 63 6f 64 65 20 63 61 75 73 65 Row opcode cause
1c20: 73 20 74 68 65 0a 62 79 74 65 63 6f 64 65 20 65 s the.bytecode e
1c30: 6e 67 69 6e 65 20 74 6f 20 70 61 75 73 65 20 61 ngine to pause a
1c40: 6e 64 20 74 68 65 20 63 6f 72 72 65 73 70 6f 6e nd the correspon
1c50: 64 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 73 74 ding [sqlite3_st
1c60: 65 70 28 29 5d 0a 63 61 6c 6c 20 74 6f 20 72 65 ep()].call to re
1c70: 74 75 72 6e 20 5b 53 51 4c 49 54 45 5f 52 4f 57 turn [SQLITE_ROW
1c80: 5d 2e 20 20 42 65 66 6f 72 65 20 69 6e 76 6f 6b ]. Before invok
1c90: 69 6e 67 0a 4f 50 5f 52 65 73 75 6c 74 52 6f 77 ing.OP_ResultRow
1ca0: 2c 20 74 68 65 20 62 79 74 65 63 6f 64 65 64 20 , the bytecoded
1cb0: 70 72 6f 67 72 61 6d 20 77 69 6c 6c 0a 68 61 76 program will.hav
1cc0: 65 20 6c 6f 61 64 65 64 20 74 68 65 20 72 65 73 e loaded the res
1cd0: 75 6c 74 73 20 66 6f 72 20 61 20 73 69 6e 67 6c ults for a singl
1ce0: 65 20 72 6f 77 20 6f 66 20 61 20 71 75 65 72 79 e row of a query
1cf0: 20 69 6e 74 6f 20 61 20 73 65 72 69 65 73 0a 6f into a series.o
1d00: 66 20 72 65 67 69 73 74 65 72 73 2e 20 20 43 2d f registers. C-
1d10: 6c 61 6e 67 75 61 67 65 20 41 50 49 73 20 73 75 language APIs su
1d20: 63 68 20 61 73 20 5b 73 71 6c 69 74 65 33 5f 63 ch as [sqlite3_c
1d30: 6f 6c 75 6d 6e 5f 69 6e 74 28 29 5d 0a 6f 72 20 olumn_int()].or
1d40: 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f [sqlite3_column_
1d50: 74 65 78 74 28 29 5d 20 65 78 74 72 61 63 74 20 text()] extract
1d60: 74 68 65 20 71 75 65 72 79 20 72 65 73 75 6c 74 the query result
1d70: 73 20 66 72 6f 6d 20 74 68 6f 73 65 0a 72 65 67 s from those.reg
1d80: 69 73 74 65 72 73 2e 20 20 54 68 65 20 62 79 74 isters. The byt
1d90: 65 63 6f 64 65 20 65 6e 67 69 6e 65 20 72 65 73 ecode engine res
1da0: 75 6d 65 73 20 77 69 74 68 20 74 68 65 20 6e 65 umes with the ne
1db0: 78 74 20 69 6e 73 74 72 75 63 74 69 6f 6e 0a 61 xt instruction.a
1dc0: 66 74 65 72 20 74 68 65 20 4f 50 5f 52 65 73 75 fter the OP_Resu
1dd0: 6c 74 52 6f 77 20 6f 6e 20 74 68 65 20 6e 65 78 ltRow on the nex
1de0: 74 20 63 61 6c 6c 0a 74 6f 20 5b 73 71 6c 69 74 t call.to [sqlit
1df0: 65 33 5f 73 74 65 70 28 29 5d 2e 0a 7d 0a 3c 2f e3_step()]..}.</
1e00: 74 63 6c 3e 0a 0a 3c 68 32 3e 52 65 67 69 73 74 tcl>..<h2>Regist
1e10: 65 72 73 3c 2f 68 32 3e 0a 0a 3c 74 63 6c 3e 0a ers</h2>..<tcl>.
1e20: 4c 69 6e 6b 4f 70 63 6f 64 65 4e 61 6d 65 73 20 LinkOpcodeNames
1e30: 7b 0a 3c 70 3e 45 76 65 72 79 20 62 79 74 65 63 {.<p>Every bytec
1e40: 6f 64 65 20 70 72 6f 67 72 61 6d 20 68 61 73 20 ode program has
1e50: 61 20 66 69 78 65 64 20 28 62 75 74 20 70 6f 74 a fixed (but pot
1e60: 65 6e 74 69 61 6c 6c 79 20 6c 61 72 67 65 29 20 entially large)
1e70: 6e 75 6d 62 65 72 20 6f 66 0a 72 65 67 69 73 74 number of.regist
1e80: 65 72 73 2e 20 20 41 20 73 69 6e 67 6c 65 20 72 ers. A single r
1e90: 65 67 69 73 74 65 72 20 63 61 6e 20 68 6f 6c 64 egister can hold
1ea0: 20 61 20 76 61 72 69 65 74 79 20 6f 66 20 6f 62 a variety of ob
1eb0: 6a 65 63 74 73 3a 0a 3c 75 6c 3e 0a 3c 6c 69 3e jects:.<ul>.<li>
1ec0: 20 41 20 4e 55 4c 4c 20 76 61 6c 75 65 0a 3c 6c A NULL value.<l
1ed0: 69 3e 20 41 20 73 69 67 6e 65 64 20 36 34 2d 62 i> A signed 64-b
1ee0: 69 74 20 69 6e 74 65 67 65 72 0a 3c 6c 69 3e 20 it integer.<li>
1ef0: 41 6e 20 49 45 45 45 20 64 6f 75 62 6c 65 2d 70 An IEEE double-p
1f00: 72 65 63 69 73 69 6f 6e 20 28 36 34 2d 62 69 74 recision (64-bit
1f10: 29 20 66 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74 ) floating point
1f20: 20 6e 75 6d 62 65 72 0a 3c 6c 69 3e 20 41 6e 20 number.<li> An
1f30: 61 72 62 69 74 72 61 72 79 20 6c 65 6e 67 74 68 arbitrary length
1f40: 20 73 74 72 69 6e 67 73 0a 3c 6c 69 3e 20 41 6e strings.<li> An
1f50: 20 61 72 62 69 74 72 61 72 79 20 6c 65 6e 67 74 arbitrary lengt
1f60: 68 20 42 4c 4f 42 0a 3c 6c 69 3e 20 41 20 52 6f h BLOB.<li> A Ro
1f70: 77 53 65 74 20 6f 62 6a 65 63 74 20 28 53 65 65 wSet object (See
1f80: 20 74 68 65 20 4f 50 5f 52 6f 77 53 65 74 41 64 the OP_RowSetAd
1f90: 64 2c 20 4f 50 5f 52 6f 77 53 65 74 52 65 61 64 d, OP_RowSetRead
1fa0: 2c 20 61 6e 64 0a 20 20 20 20 20 20 20 20 20 20 , and.
1fb0: 20 20 20 20 20 20 20 20 20 20 20 20 4f 50 5f 52 OP_R
1fc0: 6f 77 53 65 74 54 65 73 74 20 6f 70 63 6f 64 65 owSetTest opcode
1fd0: 73 29 0a 3c 6c 69 3e 20 41 20 46 72 61 6d 65 20 s).<li> A Frame
1fe0: 6f 62 6a 65 63 74 20 28 55 73 65 64 20 62 79 20 object (Used by
1ff0: 5b 73 75 62 70 72 6f 67 72 61 6d 73 5d 20 2d 20 [subprograms] -
2000: 73 65 65 20 4f 50 5f 50 72 6f 67 72 61 6d 29 0a see OP_Program).
2010: 3c 2f 75 6c 3e 0a 7d 0a 3c 2f 74 63 6c 3e 0a 0a </ul>.}.</tcl>..
2020: 3c 70 3e 41 20 72 65 67 69 73 74 65 72 20 63 61 <p>A register ca
2030: 6e 20 61 6c 73 6f 20 62 65 20 22 55 6e 64 65 66 n also be "Undef
2040: 69 6e 65 64 22 20 6d 65 61 6e 69 6e 67 20 74 68 ined" meaning th
2050: 61 74 20 69 74 20 68 6f 6c 64 73 20 6e 6f 20 76 at it holds no v
2060: 61 6c 75 65 0a 61 74 20 61 6c 6c 2e 20 20 55 6e alue.at all. Un
2070: 64 65 66 69 6e 65 64 20 69 73 20 64 69 66 66 65 defined is diffe
2080: 72 65 6e 74 20 66 72 6f 6d 20 4e 55 4c 4c 2e 20 rent from NULL.
2090: 20 44 65 70 65 6e 64 69 6e 67 20 6f 6e 20 63 6f Depending on co
20a0: 6d 70 69 6c 65 2d 74 69 6d 65 0a 6f 70 74 69 6f mpile-time.optio
20b0: 6e 73 2c 20 61 6e 20 61 74 74 65 6d 70 74 20 74 ns, an attempt t
20c0: 6f 20 72 65 61 64 20 61 6e 20 75 6e 64 65 66 69 o read an undefi
20d0: 6e 65 64 20 72 65 67 69 73 74 65 72 20 77 69 6c ned register wil
20e0: 6c 20 75 73 75 61 6c 6c 79 20 63 61 75 73 65 0a l usually cause.
20f0: 61 20 72 75 6e 2d 74 69 6d 65 20 65 72 72 6f 72 a run-time error
2100: 2e 20 20 49 66 20 74 68 65 20 63 6f 64 65 20 67 . If the code g
2110: 65 6e 65 72 61 74 6f 72 20 28 5b 73 71 6c 69 74 enerator ([sqlit
2120: 65 33 5f 70 72 65 70 61 72 65 5f 76 32 28 29 5d e3_prepare_v2()]
2130: 29 0a 65 76 65 72 20 67 65 6e 65 72 61 74 65 73 ).ever generates
2140: 20 61 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 a [prepared sta
2150: 74 65 6d 65 6e 74 5d 20 74 68 61 74 20 72 65 61 tement] that rea
2160: 64 73 20 61 6e 20 55 6e 64 65 66 69 6e 65 64 20 ds an Undefined
2170: 72 65 67 69 73 74 65 72 2c 0a 74 68 61 74 20 69 register,.that i
2180: 73 20 61 20 62 75 67 20 69 6e 20 74 68 65 20 63 s a bug in the c
2190: 6f 64 65 20 67 65 6e 65 72 61 74 6f 72 2e 0a 0a ode generator...
21a0: 3c 70 3e 0a 52 65 67 69 73 74 65 72 73 20 61 72 <p>.Registers ar
21b0: 65 20 6e 75 6d 62 65 72 65 64 20 62 65 67 69 6e e numbered begin
21c0: 6e 69 6e 67 20 77 69 74 68 20 30 2e 0a 4d 6f 73 ning with 0..Mos
21d0: 74 20 6f 70 63 6f 64 65 73 20 72 65 66 65 72 20 t opcodes refer
21e0: 74 6f 20 61 74 20 6c 65 61 73 74 20 6f 6e 65 20 to at least one
21f0: 72 65 67 69 73 74 65 72 2e 0a 0a 3c 70 3e 54 68 register...<p>Th
2200: 65 20 6e 75 6d 62 65 72 20 6f 66 20 72 65 67 69 e number of regi
2210: 73 74 65 72 73 20 69 6e 20 61 20 73 69 6e 67 6c sters in a singl
2220: 65 20 70 72 65 70 61 72 65 64 20 73 74 61 74 65 e prepared state
2230: 6d 65 6e 74 20 69 73 20 66 69 78 65 64 0a 61 74 ment is fixed.at
2240: 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 2e 20 20 compile-time.
2250: 54 68 65 20 63 6f 6e 74 65 6e 74 20 6f 66 20 61 The content of a
2260: 6c 6c 20 72 65 67 69 73 74 65 72 73 20 69 73 20 ll registers is
2270: 63 6c 65 61 72 65 64 20 77 68 65 6e 0a 61 20 70 cleared when.a p
2280: 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e repared statemen
2290: 74 20 69 73 20 5b 73 71 6c 69 74 65 33 5f 72 65 t is [sqlite3_re
22a0: 73 65 74 28 29 7c 72 65 73 65 74 5d 20 6f 72 0a set()|reset] or.
22b0: 5b 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a [sqlite3_finaliz
22c0: 65 28 29 7c 66 69 6e 61 6c 69 7a 65 64 5d 2e 0a e()|finalized]..
22d0: 0a 3c 70 3e 54 68 65 20 69 6e 74 65 72 6e 61 6c .<p>The internal
22e0: 20 4d 65 6d 20 6f 62 6a 65 63 74 20 73 74 6f 72 Mem object stor
22f0: 65 73 20 74 68 65 20 76 61 6c 75 65 20 66 6f 72 es the value for
2300: 20 61 20 73 69 6e 67 6c 65 20 72 65 67 69 73 74 a single regist
2310: 65 72 2e 0a 54 68 65 20 61 62 73 74 72 61 63 74 er..The abstract
2320: 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d [sqlite3_value]
2330: 20 6f 62 6a 65 63 74 20 74 68 61 74 20 69 73 20 object that is
2340: 65 78 70 6f 73 65 64 20 69 6e 20 74 68 65 20 41 exposed in the A
2350: 50 49 20 69 73 20 72 65 61 6c 6c 79 0a 6a 75 73 PI is really.jus
2360: 74 20 61 20 4d 65 6d 20 6f 62 6a 65 63 74 20 6f t a Mem object o
2370: 72 20 72 65 67 69 73 74 65 72 2e 0a 0a 3c 68 32 r register...<h2
2380: 3e 42 2d 54 72 65 65 20 43 75 72 73 6f 72 73 3c >B-Tree Cursors<
2390: 2f 68 32 3e 0a 0a 3c 74 63 6c 3e 0a 4c 69 6e 6b /h2>..<tcl>.Link
23a0: 4f 70 63 6f 64 65 4e 61 6d 65 73 20 7b 0a 3c 70 OpcodeNames {.<p
23b0: 3e 41 20 70 72 65 70 61 72 65 64 20 73 74 61 74 >A prepared stat
23c0: 65 6d 65 6e 74 20 63 61 6e 20 68 61 76 65 0a 7a ement can have.z
23d0: 65 72 6f 20 6f 72 20 6d 6f 72 65 20 6f 70 65 6e ero or more open
23e0: 20 63 75 72 73 6f 72 73 2e 20 20 45 61 63 68 20 cursors. Each
23f0: 63 75 72 73 6f 72 20 69 73 20 69 64 65 6e 74 69 cursor is identi
2400: 66 69 65 64 20 62 79 20 61 0a 73 6d 61 6c 6c 20 fied by a.small
2410: 69 6e 74 65 67 65 72 2c 20 77 68 69 63 68 20 69 integer, which i
2420: 73 20 75 73 75 61 6c 6c 79 20 74 68 65 20 50 31 s usually the P1
2430: 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 74 68 parameter to th
2440: 65 20 6f 70 63 6f 64 65 0a 74 68 61 74 20 75 73 e opcode.that us
2450: 65 73 20 74 68 65 20 63 75 72 73 6f 72 2e 0a 54 es the cursor..T
2460: 68 65 72 65 20 63 61 6e 20 62 65 20 6d 75 6c 74 here can be mult
2470: 69 70 6c 65 20 63 75 72 73 6f 72 73 20 6f 70 65 iple cursors ope
2480: 6e 20 6f 6e 20 74 68 65 20 73 61 6d 65 20 69 6e n on the same in
2490: 64 65 78 20 6f 72 20 74 61 62 6c 65 2e 0a 41 6c dex or table..Al
24a0: 6c 20 63 75 72 73 6f 72 73 20 6f 70 65 72 61 74 l cursors operat
24b0: 65 20 69 6e 64 65 70 65 6e 64 65 6e 74 6c 79 2c e independently,
24c0: 20 65 76 65 6e 20 63 75 72 73 6f 72 73 20 70 6f even cursors po
24d0: 69 6e 74 69 6e 67 20 74 6f 20 74 68 65 20 73 61 inting to the sa
24e0: 6d 65 0a 69 6e 64 69 63 65 73 20 6f 72 20 74 61 me.indices or ta
24f0: 62 6c 65 73 2e 0a 54 68 65 20 6f 6e 6c 79 20 77 bles..The only w
2500: 61 79 20 66 6f 72 20 74 68 65 20 76 69 72 74 75 ay for the virtu
2510: 61 6c 20 6d 61 63 68 69 6e 65 20 74 6f 20 69 6e al machine to in
2520: 74 65 72 61 63 74 20 77 69 74 68 20 61 20 64 61 teract with a da
2530: 74 61 62 61 73 65 0a 66 69 6c 65 20 69 73 20 74 tabase.file is t
2540: 68 72 6f 75 67 68 20 61 20 63 75 72 73 6f 72 2e hrough a cursor.
2550: 0a 49 6e 73 74 72 75 63 74 69 6f 6e 73 20 69 6e .Instructions in
2560: 20 74 68 65 20 76 69 72 74 75 61 6c 20 6d 61 63 the virtual mac
2570: 68 69 6e 65 20 63 61 6e 20 63 72 65 61 74 65 20 hine can create
2580: 61 20 6e 65 77 20 63 75 72 73 6f 72 20 0a 28 65 a new cursor .(e
2590: 78 3a 20 4f 50 5f 4f 70 65 6e 52 65 61 64 20 6f x: OP_OpenRead o
25a0: 72 20 4f 50 5f 4f 70 65 6e 57 72 69 74 65 29 2c r OP_OpenWrite),
25b0: 0a 72 65 61 64 20 64 61 74 61 20 66 72 6f 6d 20 .read data from
25c0: 61 20 63 75 72 73 6f 72 20 28 4f 50 5f 43 6f 6c a cursor (OP_Col
25d0: 75 6d 6e 29 2c 0a 61 64 76 61 6e 63 65 20 74 68 umn),.advance th
25e0: 65 20 63 75 72 73 6f 72 20 74 6f 20 74 68 65 20 e cursor to the
25f0: 6e 65 78 74 20 65 6e 74 72 79 20 69 6e 20 74 68 next entry in th
2600: 65 20 74 61 62 6c 65 0a 28 65 78 3a 20 4f 50 5f e table.(ex: OP_
2610: 4e 65 78 74 20 6f 72 20 4f 50 5f 50 72 65 76 29 Next or OP_Prev)
2620: 2c 20 61 6e 64 20 73 6f 20 66 6f 72 74 68 2e 0a , and so forth..
2630: 41 6c 6c 20 63 75 72 73 6f 72 73 20 61 72 65 20 All cursors are
2640: 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 0a 63 6c automatically.cl
2650: 6f 73 65 64 20 77 68 65 6e 20 74 68 65 20 70 72 osed when the pr
2660: 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 epared statement
2670: 20 69 73 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 is [sqlite3_res
2680: 65 74 28 29 7c 72 65 73 65 74 5d 20 6f 72 0a 5b et()|reset] or.[
2690: 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 sqlite3_finalize
26a0: 28 29 7c 66 69 6e 61 6c 69 7a 65 64 5d 2e 0a 7d ()|finalized]..}
26b0: 0a 3c 2f 74 63 6c 3e 0a 0a 3c 74 63 6c 3e 68 64 .</tcl>..<tcl>hd
26c0: 5f 66 72 61 67 6d 65 6e 74 20 73 75 62 70 72 6f _fragment subpro
26d0: 67 20 73 75 62 70 72 6f 67 72 61 6d 73 3c 2f 74 g subprograms</t
26e0: 63 6c 3e 0a 3c 68 32 3e 53 75 62 72 6f 75 74 69 cl>.<h2>Subrouti
26f0: 6e 65 73 2c 20 43 6f 72 6f 75 74 69 6e 65 73 2c nes, Coroutines,
2700: 20 61 6e 64 20 53 75 62 70 72 6f 67 72 61 6d 73 and Subprograms
2710: 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65 20 62 79 </h2>..<p>The by
2720: 74 65 63 6f 64 65 20 65 6e 67 69 6e 65 20 68 61 tecode engine ha
2730: 73 20 6e 6f 20 73 74 61 63 6b 20 6f 6e 20 77 68 s no stack on wh
2740: 69 63 68 20 74 6f 20 73 74 6f 72 65 20 74 68 65 ich to store the
2750: 20 72 65 74 75 72 6e 20 61 64 64 72 65 73 73 0a return address.
2760: 6f 66 20 61 20 73 75 62 72 6f 75 74 69 6e 65 2e of a subroutine.
2770: 20 20 52 65 74 75 72 6e 20 61 64 64 72 65 73 73 Return address
2780: 65 73 20 6d 75 73 74 20 62 65 20 73 74 6f 72 65 es must be store
2790: 64 20 69 6e 20 72 65 67 69 73 74 65 72 73 2e 0a d in registers..
27a0: 48 65 6e 63 65 2c 20 62 79 74 65 63 6f 64 65 20 Hence, bytecode
27b0: 73 75 62 72 6f 75 74 69 6e 65 73 20 61 72 65 20 subroutines are
27c0: 6e 6f 74 20 72 65 65 6e 74 72 61 6e 74 2e 0a 0a not reentrant...
27d0: 3c 74 63 6c 3e 0a 4c 69 6e 6b 4f 70 63 6f 64 65 <tcl>.LinkOpcode
27e0: 4e 61 6d 65 73 20 7b 0a 3c 70 3e 54 68 65 20 4f Names {.<p>The O
27f0: 50 5f 47 6f 73 75 62 20 6f 70 63 6f 64 65 20 73 P_Gosub opcode s
2800: 74 6f 72 65 73 20 74 68 65 20 63 75 72 72 65 6e tores the curren
2810: 74 20 70 72 6f 67 72 61 6d 20 63 6f 75 6e 74 65 t program counte
2820: 72 20 69 6e 74 6f 0a 72 65 67 69 73 74 65 72 20 r into.register
2830: 50 31 20 74 68 65 6e 20 6a 75 6d 70 73 20 74 6f P1 then jumps to
2840: 20 61 64 64 72 65 73 73 20 50 32 2e 20 20 54 68 address P2. Th
2850: 65 20 4f 50 5f 52 65 74 75 72 6e 20 6f 70 63 6f e OP_Return opco
2860: 64 65 20 6a 75 6d 70 73 0a 74 6f 20 61 64 64 72 de jumps.to addr
2870: 65 73 73 20 50 31 2b 31 2e 20 20 48 65 6e 63 65 ess P1+1. Hence
2880: 2c 20 65 76 65 72 79 20 73 75 62 72 6f 75 74 69 , every subrouti
2890: 6e 65 20 69 73 20 61 73 73 6f 63 69 61 74 65 64 ne is associated
28a0: 20 77 69 74 68 20 74 77 6f 20 69 6e 74 65 67 65 with two intege
28b0: 72 73 3a 0a 74 68 65 20 61 64 64 72 65 73 73 20 rs:.the address
28c0: 6f 66 20 74 68 65 20 65 6e 74 72 79 20 70 6f 69 of the entry poi
28d0: 6e 74 20 69 6e 20 74 68 65 20 73 75 62 72 6f 75 nt in the subrou
28e0: 74 69 6e 65 20 61 6e 64 20 74 68 65 20 72 65 67 tine and the reg
28f0: 69 73 74 65 72 20 6e 75 6d 62 65 72 0a 74 68 61 ister number.tha
2900: 74 20 69 73 20 75 73 65 64 20 74 6f 20 68 6f 6c t is used to hol
2910: 64 20 74 68 65 20 72 65 74 75 72 6e 20 61 64 64 d the return add
2920: 72 65 73 73 2e 0a 0a 3c 70 3e 54 68 65 20 4f 50 ress...<p>The OP
2930: 5f 59 69 65 6c 64 20 6f 70 63 6f 64 65 20 73 77 _Yield opcode sw
2940: 61 70 73 20 74 68 65 20 76 61 6c 75 65 20 6f 66 aps the value of
2950: 20 74 68 65 20 70 72 6f 67 72 61 6d 20 63 6f 75 the program cou
2960: 6e 74 65 72 20 77 69 74 68 0a 74 68 65 20 69 6e nter with.the in
2970: 74 65 67 65 72 20 76 61 6c 75 65 20 69 6e 20 72 teger value in r
2980: 65 67 69 73 74 65 72 20 50 31 2e 20 20 54 68 69 egister P1. Thi
2990: 73 20 6f 70 63 6f 64 65 20 69 73 20 75 73 65 64 s opcode is used
29a0: 20 74 6f 20 69 6d 70 6c 65 6d 65 6e 74 0a 63 6f to implement.co
29b0: 72 6f 75 74 69 6e 65 73 2e 20 20 43 6f 72 6f 75 routines. Corou
29c0: 74 69 6e 65 73 20 61 72 65 20 6f 66 74 65 6e 20 tines are often
29d0: 75 73 65 64 20 74 6f 20 69 6d 70 6c 65 6d 65 6e used to implemen
29e0: 74 20 73 75 62 71 75 65 72 69 65 73 20 66 72 6f t subqueries fro
29f0: 6d 0a 77 68 69 63 68 20 63 6f 6e 74 65 6e 74 20 m.which content
2a00: 69 73 20 70 75 6c 6c 65 64 20 6f 6e 20 61 6e 20 is pulled on an
2a10: 61 73 2d 6e 65 65 64 65 64 20 62 61 73 69 73 2e as-needed basis.
2a20: 0a 7d 0a 3c 2f 74 63 6c 3e 0a 0a 3c 70 3e 5b 43 .}.</tcl>..<p>[C
2a30: 52 45 41 54 45 20 54 52 49 47 47 45 52 7c 54 72 REATE TRIGGER|Tr
2a40: 69 67 67 65 72 73 5d 20 6e 65 65 64 20 74 6f 20 iggers] need to
2a50: 62 65 20 72 65 65 6e 74 72 61 6e 74 2e 0a 0a 3c be reentrant...<
2a60: 74 63 6c 3e 0a 4c 69 6e 6b 4f 70 63 6f 64 65 4e tcl>.LinkOpcodeN
2a70: 61 6d 65 73 20 7b 0a 53 69 6e 63 65 20 62 79 74 ames {.Since byt
2a80: 65 63 6f 64 65 0a 73 75 62 72 6f 75 74 69 6e 65 ecode.subroutine
2a90: 73 20 61 72 65 20 6e 6f 74 20 72 65 65 6e 74 72 s are not reentr
2aa0: 61 6e 74 20 61 20 64 69 66 66 65 72 65 6e 74 20 ant a different
2ab0: 6d 65 63 68 61 6e 69 73 6d 20 6d 75 73 74 20 62 mechanism must b
2ac0: 65 20 75 73 65 64 20 74 6f 0a 69 6d 70 6c 65 6d e used to.implem
2ad0: 65 6e 74 20 74 72 69 67 67 65 72 73 2e 20 20 45 ent triggers. E
2ae0: 61 63 68 20 74 72 69 67 67 65 72 20 69 73 20 69 ach trigger is i
2af0: 6d 70 6c 65 6d 65 6e 74 65 64 20 75 73 69 6e 67 mplemented using
2b00: 20 61 20 73 65 70 61 72 61 74 65 20 62 79 74 65 a separate byte
2b10: 63 6f 64 65 0a 70 72 6f 67 72 61 6d 20 77 69 74 code.program wit
2b20: 68 20 69 74 73 20 6f 77 6e 20 6f 70 63 6f 64 65 h its own opcode
2b30: 73 2c 20 70 72 6f 67 72 61 6d 20 63 6f 75 6e 74 s, program count
2b40: 65 72 2c 20 61 6e 64 20 72 65 67 69 73 74 65 72 er, and register
2b50: 20 73 65 74 2e 20 20 54 68 65 0a 4f 50 5f 50 72 set. The.OP_Pr
2b60: 6f 67 72 61 6d 20 6f 70 63 6f 64 65 20 69 6e 76 ogram opcode inv
2b70: 6f 6b 65 73 20 74 68 65 20 74 72 69 67 67 65 72 okes the trigger
2b80: 20 73 75 62 70 72 6f 67 72 61 6d 2e 20 20 54 68 subprogram. Th
2b90: 65 20 4f 50 5f 50 72 6f 67 72 61 6d 20 69 6e 73 e OP_Program ins
2ba0: 74 72 75 63 74 69 6f 6e 0a 61 6c 6c 6f 63 61 74 truction.allocat
2bb0: 65 73 20 61 6e 64 20 69 6e 69 74 69 61 6c 69 7a es and initializ
2bc0: 65 73 20 61 20 66 72 65 73 68 20 72 65 67 69 73 es a fresh regis
2bd0: 74 65 72 20 73 65 74 20 66 6f 72 20 65 61 63 68 ter set for each
2be0: 20 69 6e 76 6f 63 61 74 69 6f 6e 20 6f 66 20 74 invocation of t
2bf0: 68 65 0a 73 75 62 70 72 6f 67 72 61 6d 2c 20 73 he.subprogram, s
2c00: 6f 20 73 75 62 70 72 6f 67 72 61 6d 73 20 63 61 o subprograms ca
2c10: 6e 20 62 65 20 72 65 65 6e 74 72 61 6e 74 20 61 n be reentrant a
2c20: 6e 64 20 72 65 63 75 72 73 69 76 65 2e 20 20 54 nd recursive. T
2c30: 68 65 0a 4f 50 5f 50 61 72 61 6d 20 6f 70 63 6f he.OP_Param opco
2c40: 64 65 20 69 73 20 75 73 65 64 20 62 79 20 73 75 de is used by su
2c50: 62 70 72 6f 67 72 61 6d 73 20 74 6f 20 61 63 63 bprograms to acc
2c60: 65 73 73 20 63 6f 6e 74 65 6e 74 20 69 6e 20 72 ess content in r
2c70: 65 67 69 73 74 65 72 73 0a 6f 66 20 74 68 65 20 egisters.of the
2c80: 63 61 6c 6c 69 6e 67 20 62 79 74 65 63 6f 64 65 calling bytecode
2c90: 20 70 72 6f 67 72 61 6d 2e 0a 7d 0a 3c 2f 74 63 program..}.</tc
2ca0: 6c 3e 0a 0a 3c 68 32 3e 53 65 6c 66 2d 41 6c 74 l>..<h2>Self-Alt
2cb0: 65 72 69 6e 67 20 43 6f 64 65 3c 2f 68 32 3e 0a ering Code</h2>.
2cc0: 0a 3c 74 63 6c 3e 0a 4c 69 6e 6b 4f 70 63 6f 64 .<tcl>.LinkOpcod
2cd0: 65 4e 61 6d 65 73 20 7b 0a 3c 70 3e 53 6f 6d 65 eNames {.<p>Some
2ce0: 20 6f 70 63 6f 64 65 73 20 61 72 65 20 73 65 6c opcodes are sel
2cf0: 66 2d 61 6c 74 65 72 69 6e 67 2e 0a 46 6f 72 20 f-altering..For
2d00: 65 78 61 6d 70 6c 65 2c 20 74 68 65 20 4f 50 5f example, the OP_
2d10: 49 6e 69 74 20 6f 70 63 6f 64 65 20 28 77 68 69 Init opcode (whi
2d20: 63 68 20 69 73 20 61 6c 77 61 79 73 20 74 68 65 ch is always the
2d30: 20 66 69 72 73 74 20 6f 70 63 6f 64 65 0a 72 75 first opcode.ru
2d40: 6e 20 61 20 62 79 74 65 63 6f 64 65 20 70 72 6f n a bytecode pro
2d50: 67 72 61 6d 29 20 69 6e 63 72 65 6d 65 6e 74 73 gram) increments
2d60: 20 69 74 73 20 50 31 20 6f 70 65 72 61 6e 64 2e its P1 operand.
2d70: 20 20 53 75 62 73 65 71 75 65 6e 74 0a 4f 50 5f Subsequent.OP_
2d80: 4f 6e 63 65 20 6f 70 63 6f 64 65 73 20 63 6f 6d Once opcodes com
2d90: 70 61 72 65 20 74 68 65 69 72 20 50 31 20 6f 70 pare their P1 op
2da0: 65 72 61 6e 64 73 20 74 6f 20 74 68 65 20 50 31 erands to the P1
2db0: 20 76 61 6c 75 65 20 66 6f 72 0a 74 68 65 20 4f value for.the O
2dc0: 50 5f 49 6e 69 74 20 6f 70 63 6f 64 65 20 69 6e P_Init opcode in
2dd0: 20 6f 72 64 65 72 20 74 6f 20 64 65 74 65 72 6d order to determ
2de0: 69 6e 65 20 69 66 20 74 68 65 20 6f 6e 65 2d 74 ine if the one-t
2df0: 69 6d 65 20 69 6e 69 74 69 61 6c 69 7a 61 74 69 ime initializati
2e00: 6f 6e 0a 63 6f 64 65 20 74 68 61 74 20 66 6f 6c on.code that fol
2e10: 6c 6f 77 73 20 73 68 6f 75 6c 64 20 62 65 20 73 lows should be s
2e20: 6b 69 70 70 65 64 2e 0a 41 6e 6f 74 68 65 72 20 kipped..Another
2e30: 65 78 61 6d 70 6c 65 20 69 73 20 74 68 65 20 4f example is the O
2e40: 50 5f 53 74 72 69 6e 67 38 20 6f 70 63 6f 64 65 P_String8 opcode
2e50: 20 77 68 69 63 68 20 63 6f 6e 76 65 72 74 73 20 which converts
2e60: 69 74 73 20 50 34 0a 6f 70 65 72 61 6e 64 20 66 its P4.operand f
2e70: 72 6f 6d 20 55 54 46 2d 38 20 69 6e 74 6f 20 74 rom UTF-8 into t
2e80: 68 65 20 63 6f 72 72 65 63 74 20 64 61 74 61 62 he correct datab
2e90: 61 73 65 20 73 74 72 69 6e 67 20 65 6e 63 6f 64 ase string encod
2ea0: 69 6e 67 2c 20 74 68 65 6e 0a 63 6f 6e 76 65 72 ing, then.conver
2eb0: 74 73 20 69 74 73 65 6c 66 20 69 6e 74 6f 20 61 ts itself into a
2ec0: 20 4f 50 5f 53 74 72 69 6e 67 20 6f 70 63 6f 64 OP_String opcod
2ed0: 65 2e 0a 7d 0a 3c 2f 74 63 6c 3e 0a 0a 0a 3c 68 e..}.</tcl>...<h
2ee0: 31 3e 56 69 65 77 69 6e 67 20 54 68 65 20 42 79 1>Viewing The By
2ef0: 74 65 63 6f 64 65 3c 2f 68 31 3e 0a 0a 3c 70 3e tecode</h1>..<p>
2f00: 45 76 65 72 79 20 53 51 4c 20 73 74 61 74 65 6d Every SQL statem
2f10: 65 6e 74 20 74 68 61 74 20 53 51 4c 69 74 65 20 ent that SQLite
2f20: 69 6e 74 65 72 70 72 65 74 73 20 72 65 73 75 6c interprets resul
2f30: 74 73 20 69 6e 20 61 20 70 72 6f 67 72 61 6d 0a ts in a program.
2f40: 66 6f 72 20 74 68 65 20 76 69 72 74 75 61 6c 20 for the virtual
2f50: 6d 61 63 68 69 6e 65 2e 20 20 42 75 74 20 69 66 machine. But if
2f60: 20 74 68 65 20 53 51 4c 20 73 74 61 74 65 6d 65 the SQL stateme
2f70: 6e 74 20 62 65 67 69 6e 73 20 77 69 74 68 0a 74 nt begins with.t
2f80: 68 65 20 6b 65 79 77 6f 72 64 20 5b 45 58 50 4c he keyword [EXPL
2f90: 41 49 4e 5d 20 74 68 65 20 76 69 72 74 75 61 6c AIN] the virtual
2fa0: 20 6d 61 63 68 69 6e 65 20 77 69 6c 6c 20 6e 6f machine will no
2fb0: 74 20 65 78 65 63 75 74 65 20 74 68 65 0a 70 72 t execute the.pr
2fc0: 6f 67 72 61 6d 2e 20 20 49 6e 73 74 65 61 64 2c ogram. Instead,
2fd0: 20 74 68 65 20 69 6e 73 74 72 75 63 74 69 6f 6e the instruction
2fe0: 73 20 6f 66 20 74 68 65 20 70 72 6f 67 72 61 6d s of the program
2ff0: 20 77 69 6c 6c 20 62 65 20 72 65 74 75 72 6e 65 will be returne
3000: 64 2c 0a 6f 6e 65 20 69 6e 73 74 72 75 63 74 69 d,.one instructi
3010: 6f 6e 20 70 65 72 20 72 6f 77 2c 0a 6c 69 6b 65 on per row,.like
3020: 20 61 20 71 75 65 72 79 20 72 65 73 75 6c 74 2e a query result.
3030: 20 20 54 68 69 73 20 66 65 61 74 75 72 65 20 69 This feature i
3040: 73 20 75 73 65 66 75 6c 20 66 6f 72 20 64 65 62 s useful for deb
3050: 75 67 67 69 6e 67 20 61 6e 64 0a 66 6f 72 20 6c ugging and.for l
3060: 65 61 72 6e 69 6e 67 20 68 6f 77 20 74 68 65 20 earning how the
3070: 76 69 72 74 75 61 6c 20 6d 61 63 68 69 6e 65 20 virtual machine
3080: 6f 70 65 72 61 74 65 73 2e 20 20 46 6f 72 20 65 operates. For e
3090: 78 61 6d 70 6c 65 3a 0a 3c 2f 70 3e 0a 0a 3c 74 xample:.</p>..<t
30a0: 63 6c 3e 0a 70 72 6f 63 20 43 6f 64 65 20 7b 62 cl>.proc Code {b
30b0: 6f 64 79 7d 20 7b 0a 20 20 68 64 5f 70 75 74 73 ody} {. hd_puts
30c0: 20 7b 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 {<blockquote><p
30d0: 72 65 3e 7d 0a 20 20 72 65 67 73 75 62 20 2d 61 re>}. regsub -a
30e0: 6c 6c 20 7b 26 7d 20 5b 73 74 72 69 6e 67 20 74 ll {&} [string t
30f0: 72 69 6d 20 24 62 6f 64 79 5d 20 7b 5c 26 61 6d rim $body] {\&am
3100: 70 3b 7d 20 62 6f 64 79 0a 20 20 72 65 67 73 75 p;} body. regsu
3110: 62 20 2d 61 6c 6c 20 7b 3e 7d 20 24 62 6f 64 79 b -all {>} $body
3120: 20 7b 5c 26 67 74 3b 7d 20 62 6f 64 79 0a 20 20 {\>} body.
3130: 72 65 67 73 75 62 20 2d 61 6c 6c 20 7b 3c 7d 20 regsub -all {<}
3140: 24 62 6f 64 79 20 7b 5c 26 6c 74 3b 7d 20 62 6f $body {\<} bo
3150: 64 79 0a 20 20 72 65 67 73 75 62 20 2d 61 6c 6c dy. regsub -all
3160: 20 7b 5c 28 5c 28 5c 28 7d 20 24 62 6f 64 79 20 {\(\(\(} $body
3170: 7b 3c 62 3e 7d 20 62 6f 64 79 0a 20 20 72 65 67 {<b>} body. reg
3180: 73 75 62 20 2d 61 6c 6c 20 7b 5c 29 5c 29 5c 29 sub -all {\)\)\)
3190: 7d 20 24 62 6f 64 79 20 7b 3c 2f 62 3e 7d 20 62 } $body {</b>} b
31a0: 6f 64 79 0a 20 20 72 65 67 73 75 62 20 2d 61 6c ody. regsub -al
31b0: 6c 20 7b 20 7d 20 24 62 6f 64 79 20 7b 5c 26 6e l { } $body {\&n
31c0: 62 73 70 3b 7d 20 62 6f 64 79 0a 20 20 68 64 5f bsp;} body. hd_
31d0: 70 75 74 73 20 24 62 6f 64 79 0a 20 20 68 64 5f puts $body. hd_
31e0: 70 75 74 73 20 7b 3c 2f 70 72 65 3e 3c 2f 62 6c puts {</pre></bl
31f0: 6f 63 6b 71 75 6f 74 65 3e 7d 0a 7d 0a 0a 43 6f ockquote>}.}..Co
3200: 64 65 20 7b 0a 24 20 28 28 28 73 71 6c 69 74 65 de {.$ (((sqlite
3210: 33 20 65 78 31 2e 64 62 29 29 29 0a 73 71 6c 69 3 ex1.db))).sqli
3220: 74 65 3e 20 28 28 28 65 78 70 6c 61 69 6e 20 64 te> (((explain d
3230: 65 6c 65 74 65 20 66 72 6f 6d 20 74 62 6c 31 20 elete from tbl1
3240: 77 68 65 72 65 20 74 77 6f 3c 32 30 3b 29 29 29 where two<20;)))
3250: 0a 61 64 64 72 20 20 6f 70 63 6f 64 65 20 20 20 .addr opcode
3260: 20 20 20 20 20 20 70 31 20 20 20 20 70 32 20 20 p1 p2
3270: 20 20 70 33 20 20 20 20 70 34 20 20 20 20 20 20 p3 p4
3280: 20 20 20 20 20 20 20 70 35 20 20 63 6f 6d 6d 65 p5 comme
3290: 6e 74 20 20 20 20 20 20 0a 2d 2d 2d 2d 20 20 2d nt .---- -
32a0: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 20 20 2d 2d ------------ --
32b0: 2d 2d 20 20 2d 2d 2d 2d 20 20 2d 2d 2d 2d 20 20 -- ---- ----
32c0: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 20 20 2d ------------- -
32d0: 2d 20 20 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d - -------------
32e0: 0a 30 20 20 20 20 20 49 6e 69 74 20 20 20 20 20 .0 Init
32f0: 20 20 20 20 20 20 30 20 20 20 20 20 31 32 20 20 0 12
3300: 20 20 30 20 20 20 20 20 20 20 20 20 20 20 20 20 0
3310: 20 20 20 20 20 20 20 30 30 20 20 53 74 61 72 74 00 Start
3320: 20 61 74 20 31 32 20 20 0a 31 20 20 20 20 20 4e at 12 .1 N
3330: 75 6c 6c 20 20 20 20 20 20 20 20 20 20 20 30 20 ull 0
3340: 20 20 20 20 31 20 20 20 20 20 30 20 20 20 20 20 1 0
3350: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 0
3360: 30 20 20 72 5b 31 5d 3d 4e 55 4c 4c 20 20 20 20 0 r[1]=NULL
3370: 0a 32 20 20 20 20 20 4f 70 65 6e 57 72 69 74 65 .2 OpenWrite
3380: 20 20 20 20 20 20 30 20 20 20 20 20 32 20 20 20 0 2
3390: 20 20 30 20 20 20 20 20 33 20 20 20 20 20 20 20 0 3
33a0: 20 20 20 20 20 20 20 30 30 20 20 72 6f 6f 74 3d 00 root=
33b0: 32 20 69 44 62 3d 30 3b 20 74 62 6c 31 0a 33 20 2 iDb=0; tbl1.3
33c0: 20 20 20 20 52 65 77 69 6e 64 20 20 20 20 20 20 Rewind
33d0: 20 20 20 30 20 20 20 20 20 31 30 20 20 20 20 30 0 10 0
33e0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
33f0: 20 20 20 20 30 30 20 20 20 20 20 20 20 20 20 20 00
3400: 20 20 20 20 20 0a 34 20 20 20 20 20 20 20 43 6f .4 Co
3410: 6c 75 6d 6e 20 20 20 20 20 20 20 20 20 30 20 20 lumn 0
3420: 20 20 20 31 20 20 20 20 20 32 20 20 20 20 20 20 1 2
3430: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 30 00
3440: 20 20 72 5b 32 5d 3d 74 62 6c 31 2e 74 77 6f 0a r[2]=tbl1.two.
3450: 35 20 20 20 20 20 20 20 47 65 20 20 20 20 20 20 5 Ge
3460: 20 20 20 20 20 20 20 33 20 20 20 20 20 39 20 20 3 9
3470: 20 20 20 32 20 20 20 20 20 28 42 49 4e 41 52 59 2 (BINARY
3480: 29 20 20 20 20 20 20 20 35 31 20 20 69 66 20 72 ) 51 if r
3490: 5b 32 5d 3e 3d 72 5b 33 5d 20 67 6f 74 6f 20 39 [2]>=r[3] goto 9
34a0: 0a 36 20 20 20 20 20 20 20 52 6f 77 69 64 20 20 .6 Rowid
34b0: 20 20 20 20 20 20 20 20 30 20 20 20 20 20 34 20 0 4
34c0: 20 20 20 20 30 20 20 20 20 20 20 20 20 20 20 20 0
34d0: 20 20 20 20 20 20 20 20 20 30 30 20 20 72 5b 34 00 r[4
34e0: 5d 3d 72 6f 77 69 64 20 20 20 0a 37 20 20 20 20 ]=rowid .7
34f0: 20 20 20 4f 6e 63 65 20 20 20 20 20 20 20 20 20 Once
3500: 20 20 30 20 20 20 20 20 38 20 20 20 20 20 30 20 0 8 0
3510: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
3520: 20 20 20 30 30 20 20 20 20 20 20 20 20 20 20 20 00
3530: 20 20 20 20 0a 38 20 20 20 20 20 20 20 44 65 6c .8 Del
3540: 65 74 65 20 20 20 20 20 20 20 20 20 30 20 20 20 ete 0
3550: 20 20 31 20 20 20 20 20 30 20 20 20 20 20 74 62 1 0 tb
3560: 6c 31 20 20 20 20 20 20 20 20 20 20 20 30 32 20 l1 02
3570: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 0a 39 .9
3580: 20 20 20 20 20 4e 65 78 74 20 20 20 20 20 20 20 Next
3590: 20 20 20 20 30 20 20 20 20 20 34 20 20 20 20 20 0 4
35a0: 30 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 0
35b0: 20 20 20 20 20 30 31 20 20 20 20 20 20 20 20 20 01
35c0: 20 20 20 20 20 20 0a 31 30 20 20 20 20 4e 6f 6f .10 Noo
35d0: 70 20 20 20 20 20 20 20 20 20 20 20 30 20 20 20 p 0
35e0: 20 20 30 20 20 20 20 20 30 20 20 20 20 20 20 20 0 0
35f0: 20 20 20 20 20 20 20 20 20 20 20 20 20 30 30 20 00
3600: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 0a 31 .1
3610: 31 20 20 20 20 48 61 6c 74 20 20 20 20 20 20 20 1 Halt
3620: 20 20 20 20 30 20 20 20 20 20 30 20 20 20 20 20 0 0
3630: 30 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 0
3640: 20 20 20 20 20 30 30 20 20 20 20 20 20 20 20 20 00
3650: 20 20 20 20 20 20 0a 31 32 20 20 20 20 54 72 61 .12 Tra
3660: 6e 73 61 63 74 69 6f 6e 20 20 20 20 30 20 20 20 nsaction 0
3670: 20 20 31 20 20 20 20 20 31 20 20 20 20 20 30 20 1 1 0
3680: 20 20 20 20 20 20 20 20 20 20 20 20 20 30 31 20 01
3690: 20 75 73 65 73 53 74 6d 74 4a 6f 75 72 6e 61 6c usesStmtJournal
36a0: 3d 30 0a 31 33 20 20 20 20 54 61 62 6c 65 4c 6f =0.13 TableLo
36b0: 63 6b 20 20 20 20 20 20 30 20 20 20 20 20 32 20 ck 0 2
36c0: 20 20 20 20 31 20 20 20 20 20 74 62 6c 31 20 20 1 tbl1
36d0: 20 20 20 20 20 20 20 20 20 30 30 20 20 69 44 62 00 iDb
36e0: 3d 30 20 72 6f 6f 74 3d 32 20 77 72 69 74 65 3d =0 root=2 write=
36f0: 31 0a 31 34 20 20 20 20 49 6e 74 65 67 65 72 20 1.14 Integer
3700: 20 20 20 20 20 20 20 32 30 20 20 20 20 33 20 20 20 3
3710: 20 20 20 30 20 20 20 20 20 20 20 20 20 20 20 20 0
3720: 20 20 20 20 20 20 20 20 30 30 20 20 72 5b 33 5d 00 r[3]
3730: 3d 32 30 20 20 20 20 20 20 0a 31 35 20 20 20 20 =20 .15
3740: 47 6f 74 6f 20 20 20 20 20 20 20 20 20 20 20 30 Goto 0
3750: 20 20 20 20 20 31 20 20 20 20 20 30 20 20 20 20 1 0
3760: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
3770: 30 30 20 20 20 20 20 20 20 20 20 20 20 20 20 20 00
3780: 20 0a 7d 0a 3c 2f 74 63 6c 3e 0a 0a 3c 70 3e 41 .}.</tcl>..<p>A
3790: 6e 79 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 63 ny application c
37a0: 61 6e 20 72 75 6e 20 61 6e 20 5b 45 58 50 4c 41 an run an [EXPLA
37b0: 49 4e 5d 20 71 75 65 72 79 20 74 6f 20 67 65 74 IN] query to get
37c0: 20 6f 75 74 70 75 74 20 73 69 6d 69 6c 61 72 20 output similar
37d0: 74 6f 20 0a 74 68 65 20 61 62 6f 76 65 2e 0a 48 to .the above..H
37e0: 6f 77 65 76 65 72 2c 20 69 6e 64 65 6e 74 61 74 owever, indentat
37f0: 69 6f 6e 20 74 6f 20 73 68 6f 77 20 74 68 65 20 ion to show the
3800: 6c 6f 6f 70 20 73 74 72 75 63 74 75 72 65 20 69 loop structure i
3810: 73 20 6e 6f 74 20 67 65 6e 65 72 61 74 65 64 0a s not generated.
3820: 62 79 20 74 68 65 20 53 51 4c 69 74 65 20 63 6f by the SQLite co
3830: 72 65 2e 20 20 54 68 65 20 5b 63 6f 6d 6d 61 6e re. The [comman
3840: 64 2d 6c 69 6e 65 20 73 68 65 6c 6c 5d 20 63 6f d-line shell] co
3850: 6e 74 61 69 6e 73 20 65 78 74 72 61 20 6c 6f 67 ntains extra log
3860: 69 63 0a 66 6f 72 20 69 6e 64 65 6e 74 69 6e 67 ic.for indenting
3870: 20 6c 6f 6f 70 73 2e 0a 41 6c 73 6f 2c 20 74 68 loops..Also, th
3880: 65 20 22 63 6f 6d 6d 65 6e 74 22 20 63 6f 6c 75 e "comment" colu
3890: 6d 6e 20 69 6e 20 74 68 65 20 5b 45 58 50 4c 41 mn in the [EXPLA
38a0: 49 4e 5d 20 6f 75 74 70 75 74 0a 69 73 20 6f 6e IN] output.is on
38b0: 6c 79 20 70 72 6f 76 69 64 65 64 20 69 66 20 53 ly provided if S
38c0: 51 4c 69 74 65 20 69 73 20 63 6f 6d 70 69 6c 65 QLite is compile
38d0: 64 20 77 69 74 68 20 74 68 65 0a 5b 2d 44 53 51 d with the.[-DSQ
38e0: 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 45 58 50 4c LITE_ENABLE_EXPL
38f0: 41 49 4e 5f 43 4f 4d 4d 45 4e 54 53 5d 20 6f 70 AIN_COMMENTS] op
3900: 74 69 6f 6e 73 2e 0a 0a 3c 70 3e 57 68 65 6e 20 tions...<p>When
3910: 53 51 4c 69 74 65 20 69 73 20 63 6f 6d 70 69 6c SQLite is compil
3920: 65 64 20 77 69 74 68 20 74 68 65 20 5b 53 51 4c ed with the [SQL
3930: 49 54 45 5f 44 45 42 55 47 5d 20 63 6f 6d 70 69 ITE_DEBUG] compi
3940: 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 2c 0a le-time option,.
3950: 65 78 74 72 61 20 5b 50 52 41 47 4d 41 5d 20 63 extra [PRAGMA] c
3960: 6f 6d 6d 61 6e 64 73 20 61 72 65 20 61 76 61 69 ommands are avai
3970: 6c 61 62 6c 65 20 74 68 61 74 20 61 72 65 20 75 lable that are u
3980: 73 65 66 75 6c 20 66 6f 72 20 64 65 62 75 67 67 seful for debugg
3990: 69 6e 67 20 61 6e 64 0a 66 6f 72 20 65 78 70 6c ing and.for expl
39a0: 6f 72 69 6e 67 20 74 68 65 20 6f 70 65 72 61 74 oring the operat
39b0: 69 6f 6e 20 6f 66 20 74 68 65 20 56 44 42 45 2e ion of the VDBE.
39c0: 20 20 46 6f 72 20 65 78 61 6d 70 6c 65 20 74 68 For example th
39d0: 65 20 5b 76 64 62 65 5f 74 72 61 63 65 5d 0a 70 e [vdbe_trace].p
39e0: 72 61 67 6d 61 20 63 61 6e 20 62 65 20 65 6e 61 ragma can be ena
39f0: 62 6c 65 64 20 74 6f 20 63 61 75 73 65 20 61 20 bled to cause a
3a00: 64 69 73 61 73 73 65 6d 62 6c 79 20 6f 66 20 65 disassembly of e
3a10: 61 63 68 20 56 44 42 45 20 6f 70 63 6f 64 65 20 ach VDBE opcode
3a20: 74 6f 20 62 65 0a 70 72 69 6e 74 65 64 20 6f 6e to be.printed on
3a30: 20 73 74 61 6e 64 61 72 64 20 6f 75 74 70 75 74 standard output
3a40: 20 61 73 20 74 68 65 20 6f 70 63 6f 64 65 20 69 as the opcode i
3a50: 73 20 65 78 65 63 75 74 65 64 2e 20 20 54 68 65 s executed. The
3a60: 73 65 20 64 65 62 75 67 67 69 6e 67 0a 70 72 61 se debugging.pra
3a70: 67 6d 61 73 20 69 6e 63 6c 75 64 65 3a 0a 3c 75 gmas include:.<u
3a80: 6c 3e 0a 3c 6c 69 3e 20 5b 50 52 41 47 4d 41 20 l>.<li> [PRAGMA
3a90: 70 61 72 73 65 72 5f 74 72 61 63 65 5d 0a 3c 6c parser_trace].<l
3aa0: 69 3e 20 5b 50 52 41 47 4d 41 20 76 64 62 65 5f i> [PRAGMA vdbe_
3ab0: 61 64 64 6f 70 74 72 61 63 65 5d 0a 3c 6c 69 3e addoptrace].<li>
3ac0: 20 5b 50 52 41 47 4d 41 20 76 64 62 65 5f 64 65 [PRAGMA vdbe_de
3ad0: 62 75 67 5d 0a 3c 6c 69 3e 20 5b 50 52 41 47 4d bug].<li> [PRAGM
3ae0: 41 20 76 64 62 65 5f 6c 69 73 74 69 6e 67 5d 0a A vdbe_listing].
3af0: 3c 6c 69 3e 20 5b 50 52 41 47 4d 41 20 76 64 62 <li> [PRAGMA vdb
3b00: 65 5f 74 72 61 63 65 5d 0a 3c 2f 75 6c 3e 0a 3c e_trace].</ul>.<
3b10: 2f 70 3e 0a 0a 3c 68 31 3e 54 68 65 20 4f 70 63 /p>..<h1>The Opc
3b20: 6f 64 65 73 3c 2f 68 31 3e 0a 0a 3c 70 3e 54 68 odes</h1>..<p>Th
3b30: 65 72 65 20 61 72 65 20 63 75 72 72 65 6e 74 6c ere are currentl
3b40: 79 20 3c 74 63 6c 3e 68 64 5f 70 75 74 73 20 5b y <tcl>hd_puts [
3b50: 6c 6c 65 6e 67 74 68 20 24 4f 70 63 6f 64 65 4c llength $OpcodeL
3b60: 69 73 74 5d 3c 2f 74 63 6c 3e 0a 6f 70 63 6f 64 ist]</tcl>.opcod
3b70: 65 73 20 64 65 66 69 6e 65 64 20 62 79 20 74 68 es defined by th
3b80: 65 20 76 69 72 74 75 61 6c 20 6d 61 63 68 69 6e e virtual machin
3b90: 65 2e 0a 41 6c 6c 20 63 75 72 72 65 6e 74 6c 79 e..All currently
3ba0: 20 64 65 66 69 6e 65 64 20 6f 70 63 6f 64 65 73 defined opcodes
3bb0: 20 61 72 65 20 64 65 73 63 72 69 62 65 64 20 69 are described i
3bc0: 6e 20 74 68 65 20 74 61 62 6c 65 20 62 65 6c 6f n the table belo
3bd0: 77 2e 0a 54 68 69 73 20 74 61 62 6c 65 20 77 61 w..This table wa
3be0: 73 20 67 65 6e 65 72 61 74 65 64 20 61 75 74 6f s generated auto
3bf0: 6d 61 74 69 63 61 6c 6c 79 20 62 79 20 73 63 61 matically by sca
3c00: 6e 6e 69 6e 67 20 74 68 65 20 73 6f 75 72 63 65 nning the source
3c10: 20 63 6f 64 65 0a 66 72 6f 6d 20 74 68 65 20 66 code.from the f
3c20: 69 6c 65 0a 3c 74 63 6c 3e 0a 69 66 20 7b 24 75 ile.<tcl>.if {$u
3c30: 75 69 64 3d 3d 22 22 7d 20 7b 0a 20 20 68 64 5f uid==""} {. hd_
3c40: 70 75 74 73 20 22 3c 62 3e 76 64 62 65 2e 63 3c puts "<b>vdbe.c<
3c50: 2f 62 3e 2e 5c 6e 22 0a 7d 20 65 6c 73 65 20 7b /b>.\n".} else {
3c60: 0a 20 20 68 64 5f 70 75 74 73 20 22 3c 61 20 68 . hd_puts "<a h
3c70: 72 65 66 3d 5c 22 68 74 74 70 3a 2f 2f 77 77 77 ref=\"http://www
3c80: 2e 73 71 6c 69 74 65 2e 6f 72 67 2f 73 72 63 2f .sqlite.org/src/
3c90: 61 72 74 69 66 61 63 74 2f 24 75 75 69 64 5c 22 artifact/$uuid\"
3ca0: 3e 76 64 62 65 2e 63 3c 2f 61 3e 2e 5c 6e 22 0a >vdbe.c</a>.\n".
3cb0: 7d 0a 3c 2f 74 63 6c 3e 0a 0a 3c 70 3e 52 65 6d }.</tcl>..<p>Rem
3cc0: 65 6d 62 65 72 3a 20 54 68 65 20 56 44 42 45 20 ember: The VDBE
3cd0: 6f 70 63 6f 64 65 73 20 61 72 65 20 3c 75 3e 6e opcodes are <u>n
3ce0: 6f 74 3c 2f 75 3e 20 70 61 72 74 20 6f 66 20 74 ot</u> part of t
3cf0: 68 65 20 69 6e 74 65 72 66 61 63 65 20 0a 64 65 he interface .de
3d00: 66 69 6e 69 74 69 6f 6e 20 66 6f 72 20 53 51 4c finition for SQL
3d10: 69 74 65 2e 20 20 54 68 65 20 6e 75 6d 62 65 72 ite. The number
3d20: 20 6f 66 20 6f 70 63 6f 64 65 73 20 61 6e 64 20 of opcodes and
3d30: 74 68 65 69 72 20 6e 61 6d 65 73 20 61 6e 64 20 their names and
3d40: 6d 65 61 6e 69 6e 67 73 0a 63 68 61 6e 67 65 20 meanings.change
3d50: 66 72 6f 6d 20 6f 6e 65 20 72 65 6c 65 61 73 65 from one release
3d60: 20 6f 66 20 53 51 4c 69 74 65 20 74 6f 20 74 68 of SQLite to th
3d70: 65 20 6e 65 78 74 2e 0a 54 68 65 20 6f 70 63 6f e next..The opco
3d80: 64 65 73 20 73 68 6f 77 6e 20 69 6e 20 74 68 65 des shown in the
3d90: 20 74 61 62 6c 65 20 62 65 6c 6f 77 20 61 72 65 table below are
3da0: 20 76 61 6c 69 64 20 66 6f 72 20 53 51 4c 69 74 valid for SQLit
3db0: 65 0a 3c 74 63 6c 3e 0a 68 64 5f 70 75 74 73 20 e.<tcl>.hd_puts
3dc0: 22 20 76 65 72 73 69 6f 6e 20 24 53 51 4c 49 54 " version $SQLIT
3dd0: 45 5f 56 45 52 53 49 4f 4e 20 63 68 65 63 6b 2d E_VERSION check-
3de0: 69 6e 5c 6e 22 0a 68 64 5f 70 75 74 73 20 22 3c in\n".hd_puts "<
3df0: 61 20 68 72 65 66 3d 27 24 75 72 6c 27 3e 24 53 a href='$url'>$S
3e00: 51 4c 49 54 45 5f 48 41 53 48 3c 2f 61 3e 20 64 QLITE_HASH</a> d
3e10: 61 74 65 64 20 24 53 51 4c 49 54 45 5f 43 4b 49 ated $SQLITE_CKI
3e20: 4e 5f 44 41 54 45 2e 5c 6e 5c 6e 22 0a 0a 68 64 N_DATE.\n\n"..hd
3e30: 5f 66 72 61 67 6d 65 6e 74 20 63 6f 64 65 73 20 _fragment codes
3e40: 7b 6c 69 73 74 20 6f 66 20 63 75 72 72 65 6e 74 {list of current
3e50: 20 62 79 74 65 63 6f 64 65 73 7d 20 7b 6f 70 63 bytecodes} {opc
3e60: 6f 64 65 20 64 65 66 69 6e 69 74 69 6f 6e 73 7d ode definitions}
3e70: 0a 20 0a 68 64 5f 70 75 74 73 20 7b 0a 20 20 3c . .hd_puts {. <
3e80: 2f 64 69 76 3e 0a 20 20 3c 73 74 79 6c 65 3e 2e /div>. <style>.
3e90: 6f 70 74 61 62 20 74 64 20 7b 76 65 72 74 69 63 optab td {vertic
3ea0: 61 6c 2d 61 6c 69 67 6e 3a 74 6f 70 3b 20 70 61 al-align:top; pa
3eb0: 64 64 69 6e 67 3a 20 31 65 78 20 31 65 78 3b 7d dding: 1ex 1ex;}
3ec0: 3c 2f 73 74 79 6c 65 3e 0a 20 20 3c 64 69 76 20 </style>. <div
3ed0: 63 6c 61 73 73 3d 22 6f 70 74 61 62 22 3e 0a 20 class="optab">.
3ee0: 20 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 74 61 <blockquote><ta
3ef0: 62 6c 65 20 63 65 6c 6c 73 70 61 63 69 6e 67 3d ble cellspacing=
3f00: 30 20 62 6f 72 64 65 72 3d 31 20 63 65 6c 6c 70 0 border=1 cellp
3f10: 61 64 64 69 6e 3e 0a 20 20 3c 74 72 3e 3c 74 68 addin>. <tr><th
3f20: 3e 4f 70 63 6f 64 65 20 4e 61 6d 65 3c 2f 74 68 >Opcode Name</th
3f30: 3e 3c 74 68 3e 44 65 73 63 72 69 70 74 69 6f 6e ><th>Description
3f40: 3c 2f 74 68 3e 3c 2f 74 72 3e 0a 7d 0a 66 6f 72 </th></tr>.}.for
3f50: 65 61 63 68 20 6f 70 20 5b 6c 73 6f 72 74 20 2d each op [lsort -
3f60: 64 69 63 74 69 6f 6e 61 72 79 20 24 4f 70 63 6f dictionary $Opco
3f70: 64 65 4c 69 73 74 5d 20 7b 0a 20 20 68 64 5f 70 deList] {. hd_p
3f80: 75 74 73 20 7b 3c 74 72 3e 3c 74 64 20 76 61 6c uts {<tr><td val
3f90: 69 67 6e 3d 22 74 6f 70 22 20 61 6c 69 67 6e 3d ign="top" align=
3fa0: 22 63 65 6e 74 65 72 22 3e 7d 0a 20 20 68 64 5f "center">}. hd_
3fb0: 70 75 74 73 20 22 5c 6e 3c 61 20 6e 61 6d 65 3d puts "\n<a name=
3fc0: 5c 22 24 6f 70 5c 22 3e 3c 2f 61 3e 24 6f 70 5c \"$op\"></a>$op\
3fd0: 6e 22 0a 20 20 72 65 67 73 75 62 20 2d 61 6c 6c n". regsub -all
3fe0: 20 7b 5c 5b 28 50 5b 30 2d 39 2b 5d 2b 29 5c 5d {\[(P[0-9+]+)\]
3ff0: 7d 20 24 4f 70 63 6f 64 65 28 24 6f 70 3a 74 65 } $Opcode($op:te
4000: 78 74 29 20 7b 5c 26 23 39 31 3b 5c 31 5c 26 23 xt) {\[\1\&#
4010: 39 33 7d 20 74 78 74 0a 20 20 68 64 5f 70 75 74 93} txt. hd_put
4020: 73 20 22 3c 74 64 3e 22 0a 20 20 73 65 74 20 74 s "<td>". set t
4030: 78 74 20 5b 73 74 72 69 6e 67 20 74 72 69 6d 20 xt [string trim
4040: 24 74 78 74 5d 0a 20 20 69 66 20 7b 5b 73 74 72 $txt]. if {[str
4050: 69 6e 67 20 6d 61 74 63 68 20 3c 70 3e 2a 20 24 ing match <p>* $
4060: 74 78 74 5d 7d 20 7b 73 65 74 20 74 78 74 20 5b txt]} {set txt [
4070: 73 74 72 69 6e 67 20 72 61 6e 67 65 20 24 74 78 string range $tx
4080: 74 20 33 20 65 6e 64 5d 7d 0a 20 20 4c 69 6e 6b t 3 end]}. Link
4090: 4f 70 63 6f 64 65 4e 61 6d 65 73 20 24 74 78 74 OpcodeNames $txt
40a0: 0a 20 20 68 64 5f 70 75 74 73 20 22 3c 2f 74 64 . hd_puts "</td
40b0: 3e 3c 2f 74 72 3e 5c 6e 22 0a 7d 0a 68 64 5f 72 ></tr>\n".}.hd_r
40c0: 65 73 6f 6c 76 65 20 7b 0a 20 20 3c 2f 74 61 62 esolve {. </tab
40d0: 6c 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e le></blockquote>
40e0: 0a 20 20 3c 2f 64 69 76 3e 0a 7d 0a 3c 2f 74 63 . </div>.}.</tc
40f0: 6c 3e 0a l>.