sqlite&gt;&nbsp;<b>select&nbsp;*&nbsp;from&nbsp;tbl1;</b><br>hello&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;10&nbsp;&nbsp;&nbsp;&nbsp;<br>goodbye&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;20&nbsp;&nbsp;&nbsp;&nbsp;<br>sqlite&gt;</tt></blockquote><p>Another useful output mode is "insert".  In insert mode, the outputis formatted to look like SQL INSERT statements.  You can use insertmode to generate text that can later be used to input data into a different database.</p><p>When specifying insert mode, you have to give an extra argumentwhich is the name of the table to be inserted into.  For example:</p><blockquote><tt>sqlite&gt;&nbsp;<b>.mode&nbsp;insert&nbsp;new_table</b><br>sqlite&gt;&nbsp;<b>select&nbsp;*&nbsp;from&nbsp;tbl1;</b><br>INSERT&nbsp;INTO&nbsp;'new_table'&nbsp;VALUES('hello',10);<br>INSERT&nbsp;INTO&nbsp;'new_table'&nbsp;VALUES('goodbye',20);<br>sqlite&gt;</tt></blockquote><p>The last output mode is "html".  In this mode, sqlite3 writesthe results of the query as an XHTML table.  The beginning&lt;TABLE&gt; and the ending &lt;/TABLE&gt; are not written, butall of the intervening &lt;TR&gt;s, &lt;TH&gt;s, and &lt;TD&gt;sare.  The html output mode is envisioned as being useful forCGI.</p><h3>Writing results to a file</h3><p>By default, sqlite3 sends query results to standard output.  Youcan change this using the ".output" command.  Just put the name ofan output file as an argument to the .output command and all subsequentquery results will be written to that file.  Use ".output stdout" tobegin writing to standard output again.  For example:</p><blockquote><tt>sqlite&gt;&nbsp;<b>.mode&nbsp;list</b><br>sqlite&gt;&nbsp;<b>.separator&nbsp;|</b><br>sqlite&gt;&nbsp;<b>.output&nbsp;test_file_1.txt</b><br>sqlite&gt;&nbsp;<b>select&nbsp;*&nbsp;from&nbsp;tbl1;</b><br>sqlite&gt;&nbsp;<b>.exit</b><br>$&nbsp;<b>cat&nbsp;test_file_1.txt</b><br>hello|10<br>goodbye|20<br>$</tt></blockquote><h3>Querying the database schema</h3><p>The sqlite3 program provides several convenience commands thatare useful for looking at the schema of the database.  There isnothing that these commands do that cannot be done by some othermeans.  These commands are provided purely as a shortcut.</p><p>For example, to see a list of the tables in the database, youcan enter ".tables".</p><blockquote><tt>sqlite&gt;&nbsp;<b>.tables</b><br>tbl1<br>tbl2<br>sqlite&gt;</tt></blockquote><p>The ".tables" command is similar to setting list mode thenexecuting the following query:</p><blockquote><pre>SELECT name FROM sqlite_master WHERE type IN ('table','view') AND name NOT LIKE 'sqlite_%'UNION ALL SELECT name FROM sqlite_temp_master WHERE type IN ('table','view') ORDER BY 1</pre></blockquote><p>In fact, if you look at the source code to the sqlite3 program(found in the source tree in the file src/shell.c) you'll findexactly the above query.</p><p>The ".indices" command works in a similar way to list all ofthe indices for a particular table.  The ".indices" command takesa single argument which is the name of the table for which theindices are desired.  Last, but not least, is the ".schema" command.With no arguments, the ".schema" command shows the original CREATE TABLEand CREATE INDEX statements that were used to build the current database.If you give the name of a table to ".schema", it shows the originalCREATE statement used to make that table and all if its indices.We have:</p><blockquote><tt>sqlite&gt;&nbsp;<b>.schema</b><br>create&nbsp;table&nbsp;tbl1(one&nbsp;varchar(10),&nbsp;two&nbsp;smallint)<br>CREATE&nbsp;TABLE&nbsp;tbl2&nbsp;(<br>&nbsp;&nbsp;f1&nbsp;varchar(30)&nbsp;primary&nbsp;key,<br>&nbsp;&nbsp;f2&nbsp;text,<br>&nbsp;&nbsp;f3&nbsp;real<br>)<br>sqlite&gt;&nbsp;<b>.schema&nbsp;tbl2</b><br>CREATE&nbsp;TABLE&nbsp;tbl2&nbsp;(<br>&nbsp;&nbsp;f1&nbsp;varchar(30)&nbsp;primary&nbsp;key,<br>&nbsp;&nbsp;f2&nbsp;text,<br>&nbsp;&nbsp;f3&nbsp;real<br>)<br>sqlite&gt;</tt></blockquote><p>The ".schema" command accomplishes the same thing as settinglist mode, then entering the following query:</p><blockquote><pre>SELECT sql FROM    (SELECT * FROM sqlite_master UNION ALL    SELECT * FROM sqlite_temp_master)WHERE type!='meta'ORDER BY tbl_name, type DESC, name</pre></blockquote><p>Or, if you give an argument to ".schema" because you onlywant the schema for a single table, the query looks like this:</p><blockquote><pre>SELECT sql FROM   (SELECT * FROM sqlite_master UNION ALL    SELECT * FROM sqlite_temp_master)WHERE type!='meta' AND sql NOT NULL AND name NOT LIKE 'sqlite_%'ORDER BY substr(type,2,1), name</pre></blockquote><p>You can supply an argument to the .schema command.  If you do, thequery looks like this:</p><blockquote><pre>SELECT sql FROM   (SELECT * FROM sqlite_master UNION ALL    SELECT * FROM sqlite_temp_master)WHERE tbl_name LIKE '%s'  AND type!='meta' AND sql NOT NULL AND name NOT LIKE 'sqlite_%'ORDER BY substr(type,2,1), name</pre></blockquote><p>The "%s" in the query is replace by your argument.  This allows youto view the schema for some subset of the database.</p><blockquote><tt>sqlite&gt;&nbsp;<b>.schema&nbsp;%abc%</b></tt></blockquote><p>Along these same lines,the ".table" command also accepts a pattern as its first argument.If you give an argument to the .table command, a "%" is bothappended and prepended and a LIKE clause is added to the query.This allows you to list only those tables that match a particularpattern.</p><p>The ".databases" command shows a list of all databases open inthe current connection.  There will always be at least 2.  The firstone is "main", the original database opened.  The second is "temp",the database used for temporary tables. There may be additional databases listed for databases attached using the ATTACH statement.The first output column is the name the database is attached with, and the second column is the filename of the external file.</p><blockquote><tt>sqlite&gt;&nbsp;<b>.databases</b></tt></blockquote><h3>Converting An Entire Database To An ASCII Text File</h3><p>Use the ".dump" command to convert the entire contents of adatabase into a single ASCII text file.  This file can be convertedback into a database by piping it back into <b>sqlite3</b>.</p><p>A good way to make an archival copy of a database is this:</p><blockquote><tt>$&nbsp;<b>echo&nbsp;'.dump'&nbsp;|&nbsp;sqlite3&nbsp;ex1&nbsp;|&nbsp;gzip&nbsp;-c&nbsp;&gt;ex1.dump.gz</b></tt></blockquote><p>This generates a file named <b>ex1.dump.gz</b> that contains everythingyou need to reconstruct the database at a later time, or on anothermachine.  To reconstruct the database, just type:</p><blockquote><tt>$&nbsp;<b>zcat&nbsp;ex1.dump.gz&nbsp;|&nbsp;sqlite3&nbsp;ex2</b></tt></blockquote><p>The text format is pure SQL so youcan also use the .dump command to export an SQLite databaseinto other popular SQL database engines.  Like this:</p><blockquote><tt>$&nbsp;<b>createdb&nbsp;ex2</b><br>$&nbsp;<b>sqlite3&nbsp;ex1&nbsp;.dump&nbsp;|&nbsp;psql&nbsp;ex2</b></tt></blockquote><h3>Other Dot Commands</h3><p>The ".explain" dot command can be used to set the output modeto "column" and to set the column widths to values that are reasonablefor looking at the output of an EXPLAIN command.  The EXPLAIN commandis an SQLite-specific SQL extension that is useful for debugging.  If anyregular SQL is prefaced by EXPLAIN, then the SQL command is parsed andanalyzed but is not executed.  Instead, the sequence of virtual machineinstructions that would have been used to execute the SQL command arereturned like a query result.  For example:</p><blockquote><tt>sqlite&gt;&nbsp;<b>.explain</b><br>sqlite&gt;&nbsp;<b>explain&nbsp;delete&nbsp;from&nbsp;tbl1&nbsp;where&nbsp;two&lt;20;</b><br>addr&nbsp;&nbsp;opcode&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;p1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;p2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;p3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>----&nbsp;&nbsp;------------&nbsp;&nbsp;-----&nbsp;&nbsp;-----&nbsp;&nbsp;-------------------------------------&nbsp;&nbsp;&nbsp;<br>0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ListOpen&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Open&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;tbl1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Next&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;9&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Integer&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;20&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>5&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Ge&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>6&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Key&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>7&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ListWrite&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>8&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Goto&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>9&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Noop&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>10&nbsp;&nbsp;&nbsp;&nbsp;ListRewind&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>11&nbsp;&nbsp;&nbsp;&nbsp;ListRead&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;14&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>12&nbsp;&nbsp;&nbsp;&nbsp;Delete&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>13&nbsp;&nbsp;&nbsp;&nbsp;Goto&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;11&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>14&nbsp;&nbsp;&nbsp;&nbsp;ListClose&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0</tt></blockquote><p>The ".timeout" command sets the amount of time that the <b>sqlite3</b>program will wait for locks to clear on files it is trying to accessbefore returning an error.  The default value of the timeout is zero sothat an error is returned immediately if any needed database table orindex is locked.</p><p>And finally, we mention the ".exit" command which causes thesqlite3 program to exit.</p><h3>Using sqlite3 in a shell script</h3><p>One way to use sqlite3 in a shell script is to use "echo" or"cat" to generate a sequence of commands in a file, then invoke sqlite3while redirecting input from the generated command file.  Thisworks fine and is appropriate in many circumstances.  But asan added convenience, sqlite3 allows a single SQL command to beentered on the command line as a second argument after thedatabase name.  When the sqlite3 program is launched with twoarguments, the second argument is passed to the SQLite libraryfor processing, the query results are printed on standard outputin list mode, and the program exits.  This mechanism is designedto make sqlite3 easy to use in conjunction with programs like"awk".  For example:</p><blockquote><tt>$&nbsp;<b>sqlite3&nbsp;ex1&nbsp;'select&nbsp;*&nbsp;from&nbsp;tbl1'&nbsp;|</b><br>&gt;&nbsp;<b>&nbsp;awk&nbsp;'{printf&nbsp;"&lt;tr&gt;&lt;td&gt;%s&lt;td&gt;%s\n",$1,$2&nbsp;}'</b><br>&lt;tr&gt;&lt;td&gt;hello&lt;td&gt;10<br>&lt;tr&gt;&lt;td&gt;goodbye&lt;td&gt;20<br>$</tt></blockquote><h3>Ending shell commands</h3><p>SQLite commands are normally terminated by a semicolon.  In the shell you can also use the word "GO" (case-insensitive) or a slash character "/" on a line by itself to end a command.  These are used by SQL Server and Oracle, respectively.  These won't work in <b>sqlite3_exec()</b>, because the shell translates these into a semicolon before passing them to that function.</p><h3>Compiling the sqlite3 program from sources</h3><p>The sqlite3 program is built automatically when you compile theSQLite library.  Just get a copy of the source tree, run"configure" and then "make".</p>footer $rcsid<hr><small<i>This page last modified 2007/12/20 02:09:02 UTC</i></small></div></body></html>