<title>Command Line Shell For SQLite</title> <tcl>hd_keywords {CLI} {Command Line Interface} {command-line shell} \ {command-line interface} </tcl> <h1 align=center> Command Line Shell For SQLite </h1> <p>The SQLite project provides a simple command-line utility named <b>sqlite3</b> (or <b>sqlite3.exe</b> on windows) that allows the user to manually enter and execute SQL statements against an SQLite database. This document provides a brief introduction on how to use the <b>sqlite3</b> program. <h3>Getting Started</h3> <p>To start the <b>sqlite3</b> program, just type "sqlite3" optionally followed by the name the file that holds the SQLite database. If the file does not exist, a new database file with the given name will be created automatically. If no database file is specified, a temporary database is created, then deleted when the "sqlite3" program exits. <p>When started, the <b>sqlite3</b> program will show a brief banner message then prompt you to enter SQL. Type in SQL statements (terminated by a semicolon), press "Enter" and the SQL will be executed.</p> <p>For example, to create a new SQLite database named "ex1" with a single table named "tbl1", you might do this:</p> <tcl> proc DisplayCode {body} { hd_puts {<blockquote><pre>} regsub -all {&} [string trim $body] {\&} body regsub -all {>} $body {\>} body regsub -all {<} $body {\<} body regsub -all {\(\(\(} $body {<b>} body regsub -all {\)\)\)} $body {</b>} body regsub -all {\[\[\[} $body {<i>} body regsub -all {\]\]\]} $body {</i>} body #regsub -all { } $body {\ } body #regsub -all \n $body <br>\n body hd_puts $body hd_puts {</pre></blockquote>} } DisplayCode { $ (((sqlite3 ex1))) SQLite version 3.8.5 2014-05-29 12:36:14 Enter ".help" for usage hints. sqlite> (((create table tbl1(one varchar(10), two smallint);))) sqlite> (((insert into tbl1 values('hello!',10);))) sqlite> (((insert into tbl1 values('goodbye', 20);))) sqlite> (((select * from tbl1;))) hello!|10 goodbye|20 sqlite> } </tcl> <p>You can terminate the sqlite3 program by typing your systems End-Of-File character (usually a Control-D). Use the interrupt character (usually a Control-C) to stop a long-running SQL statement.</p> <p>Make sure you type a semicolon at the end of each SQL command! The sqlite3 program looks for a semicolon to know when your SQL command is complete. If you omit the semicolon, sqlite3 will give you a continuation prompt and wait for you to enter more text to be added to the current SQL command. This feature allows you to enter SQL commands that span multiple lines. For example:</p> <tcl>DisplayCode { sqlite> (((CREATE TABLE tbl2 ())) ...> ((( f1 varchar(30) primary key,))) ...> ((( f2 text,))) ...> ((( f3 real))) ...> ((();))) sqlite> }</tcl> <h3>Double-click Startup On Windows</h3> <p>Windows users can double-click on the <b>sqlite3.exe</b> icon to cause the command-line shell to pop-up a terminal window running SQLite. Note, however, that by default this SQLite session is using an in-memory database, not a file on disk, and so all changes will be lost when the session exits. To use a persistent disk file as the database, enter the ".open" command immediately after the terminal window starts up: <tcl>DisplayCode { SQLite version 3.8.5 2014-05-29 12:36:14 Enter ".help" for usage hints. Connected to a transient in-memory database. Use ".open FILENAME" to reopen on a persistent database. sqlite> (((.open ex1.db))) sqlite> }</tcl> <p>The example above causes the database file named "ex1.db" to be opened and used, and created if it does not previously exist. You might want to use a full pathname to ensure that the file is in the directory that you think it is in. Use forward-slashes as the directory separator character. In other words use "c:/work/ex1.db", not "c:\work\ex1.db".</p> <p>Alternatively, you can create a new database using the default in-memory storage, then save that database into a disk file using the ".save" command: <tcl>DisplayCode { SQLite version 3.8.5 2014-05-29 12:36:14 Enter ".help" for usage hints. Connected to a transient in-memory database. Use ".open FILENAME" to reopen on a persistent database. sqlite> [[[... many SQL commands omitted ...]]] sqlite> (((.save ex1.db))) sqlite> }</tcl> <p>Be careful when using the ".save" command as it will overwrite any preexisting database files having the same name without prompting for confirmation. As with the ".open" command, you might want to use a full pathname with forward-slash directory separators to avoid abiguity. <h3>Special commands to sqlite3</h3> <p> Most of the time, sqlite3 just reads lines of input and passes them on to the SQLite library for execution. But if an input line begins with a dot ("."), then that line is intercepted and interpreted by the sqlite3 program itself. These "dot commands" are typically used to change the output format of queries, or to execute certain prepackaged query statements. </p> <p> For a listing of the available dot commands, you can enter ".help" at any time. For example: </p> <tcl>DisplayCode { sqlite> (((.help))) .backup ?DB? FILE Backup DB (default "main") to FILE .bail on|off Stop after hitting an error. Default OFF .clone NEWDB Clone data into NEWDB from the existing database .databases List names and files of attached databases .dump ?TABLE? ... Dump the database in an SQL text format If TABLE specified, only dump tables matching LIKE pattern TABLE. .echo on|off Turn command echo on or off .exit Exit this program .explain ?on|off? Turn output mode suitable for EXPLAIN on or off. With no args, it turns EXPLAIN on. .headers on|off Turn display of headers on or off .help Show this message .import FILE TABLE Import data from FILE into TABLE .indices ?TABLE? Show names of all indices If TABLE specified, only show indices for tables matching LIKE pattern TABLE. .load FILE ?ENTRY? Load an extension library .log FILE|off Turn logging on or off. FILE can be stderr/stdout .mode MODE ?TABLE? Set output mode where MODE is one of: csv Comma-separated values column Left-aligned columns. (See .width) html HTML <table> code insert SQL insert statements for TABLE line One value per line list Values delimited by .separator string tabs Tab-separated values tcl TCL list elements .nullvalue STRING Use STRING in place of NULL values .once FILENAME Output for the next SQL command only to FILENAME .open ?FILENAME? Close existing database and reopen FILENAME .output ?FILENAME? Send output to FILENAME or stdout .print STRING... Print literal STRING .prompt MAIN CONTINUE Replace the standard prompts .quit Exit this program .read FILENAME Execute SQL in FILENAME .restore ?DB? FILE Restore content of DB (default "main") from FILE .save FILE Write in-memory database into FILE .schema ?TABLE? Show the CREATE statements If TABLE specified, only show tables matching LIKE pattern TABLE. .separator STRING Change separator used by output mode and .import .shell CMD ARGS... Run CMD ARGS... in a system shell .show Show the current values for various settings .stats on|off Turn stats on or off .system CMD ARGS... Run CMD ARGS... in a system shell .tables ?TABLE? List names of tables If TABLE specified, only list tables matching LIKE pattern TABLE. .timeout MS Try opening locked tables for MS milliseconds .timer on|off Turn SQL timer on or off .trace FILE|off Output each SQL statement as it is run .vfsname ?AUX? Print the name of the VFS stack .width NUM1 NUM2 ... Set column widths for "column" mode Negative values right-justify sqlite> }</tcl> <h3>Rules for "dot-commands"</h3> <p>Ordinary SQL statements are free-form, and can be spread across multiple lines, and can have whitespace and comments anywhere. But dot-commands are more restrictive: <ul> <li>A dot-command must begin with the "." at the left margin with no preceding whitespace. <li>The dot-command must be entirely contained on a single input line. <li>A dot-command cannot occur in the middle of an ordinary SQL statement. In other words, a dot-command cannot occur at a continuation prompt. <li>Dot-commands do not recognize comments. </ul> <p>And, of course, it is important to remember that the dot-commands are interpreted by the sqlite3.exe command-line program, not by SQLite itself. So none of the dot-commands will work as an argument to SQLite interfaces like [sqlite3_prepare()] or [sqlite3_exec()]. <h3>Changing Output Formats</h3> <p>The sqlite3 program is able to show the results of a query in eight different formats: "csv", "column", "html", "insert", "line", "list", "tabs", and "tcl". You can use the ".mode" dot command to switch between these output formats.</p> <p>The default output mode is "list". In list mode, each record of a query result is written on one line of output and each column within that record is separated by a specific separator string. The default separator is a pipe symbol ("|"). List mode is especially useful when you are going to send the output of a query to another program (such as AWK) for additional processing.</p> <tcl>DisplayCode { sqlite> (((.mode list))) sqlite> (((select * from tbl1;))) hello|10 goodbye|20 sqlite> }</tcl> <p>You can use the ".separator" dot command to change the separator for list mode. For example, to change the separator to a comma and a space, you could do this:</p> <tcl>DisplayCode { sqlite> (((.separator ", "))) sqlite> (((select * from tbl1;))) hello, 10 goodbye, 20 sqlite> }</tcl> <p>In "line" mode, each column in a row of the database is shown on a line by itself. Each line consists of the column name, an equal sign and the column data. Successive records are separated by a blank line. Here is an example of line mode output:</p> <tcl>DisplayCode { sqlite> (((.mode line))) sqlite> (((select * from tbl1;))) one = hello two = 10 one = goodbye two = 20 sqlite> }</tcl> <p>In column mode, each record is shown on a separate line with the data aligned in columns. For example:</p> <tcl>DisplayCode { sqlite> (((.mode column))) sqlite> (((select * from tbl1;))) one two ---------- ---------- hello 10 goodbye 20 sqlite> }</tcl> <p>By default, each column is at least 10 characters wide. Data that is too wide to fit in a column is truncated. You can adjust the column widths using the ".width" command. Like this:</p> <tcl>DisplayCode { sqlite> (((.width 12 6))) sqlite> (((select * from tbl1;))) one two ------------ ------ hello 10 goodbye 20 sqlite> }</tcl> <p>The ".width" command in the example above sets the width of the first column to 12 and the width of the second column to 6. All other column widths were unaltered. You can gives as many arguments to ".width" as necessary to specify the widths of as many columns as are in your query results.</p> <p>If you specify a column a width of 0, then the column width is automatically adjusted to be the maximum of three numbers: 10, the width of the header, and the width of the first row of data. This makes the column width self-adjusting. The default width setting for every column is this auto-adjusting 0 value.</p> <p>You can specify a negative column width to get right-justified columns.</p> <p>The column labels that appear on the first two lines of output can be turned on and off using the ".header" dot command. In the examples above, the column labels are on. To turn them off you could do this:</p> <tcl>DisplayCode { sqlite> (((.header off))) sqlite> (((select * from tbl1;))) hello 10 goodbye 20 sqlite> }</tcl> <p>Another useful output mode is "insert". In insert mode, the output is formatted to look like SQL INSERT statements. You can use insert mode 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 argument which is the name of the table to be inserted into. For example:</p> <tcl>DisplayCode { sqlite> (((.mode insert new_table))) sqlite> (((select * from tbl1;))) INSERT INTO 'new_table' VALUES('hello',10); INSERT INTO 'new_table' VALUES('goodbye',20); sqlite> }</tcl> <p>The last output mode is "html". In this mode, sqlite3 writes the results of the query as an XHTML table. The beginning <TABLE> and the ending </TABLE> are not written, but all of the intervening <TR>s, <TH>s, and <TD>s are. The html output mode is envisioned as being useful for CGI.</p> <p>The ".explain" dot command can be used to set the output mode to "column" and to set the column widths to values that are reasonable for looking at the output of an EXPLAIN command. The EXPLAIN command is an SQLite-specific SQL extension that is useful for debugging. If any regular SQL is prefaced by EXPLAIN, then the SQL command is parsed and analyzed but is not executed. Instead, the sequence of virtual machine instructions that would have been used to execute the SQL command are returned like a query result. For example:</p> <tcl>DisplayCode { sqlite> (((.explain))) sqlite> (((explain delete from tbl1 where two<20;))) addr opcode p1 p2 p3 p4 p5 comment ---- ------------- ---- ---- ---- ------------- -- ------------- 0 Trace 0 0 0 00 1 Goto 0 18 0 00 2 Null 0 1 0 00 r[1]=NULL 3 OpenRead 0 2 0 2 00 root=2 iDb=0; tbl1 4 Rewind 0 10 0 00 5 Column 0 1 2 00 r[2]=tbl1.two 6 Ge 3 9 2 (BINARY) 6a if r[3]>=r[2] goto 10 7 Rowid 0 4 0 00 r[4]=rowid 8 RowSetAdd 1 4 0 00 rowset(1)=r[4] 9 Next 0 7 0 01 10 Close 0 0 0 00 11 OpenWrite 0 2 0 2 00 root=2 iDb=0; tbl1 12 RowSetRead 1 16 4 00 r[4]=rowset(1) 13 NotExists 0 12 4 1 00 intkey=r[4] 14 Delete 0 1 0 tbl1 00 15 Goto 0 12 0 00 16 Close 0 0 0 00 17 Halt 0 0 0 00 18 Transaction 0 1 0 00 19 VerifyCookie 0 1 0 00 20 TableLock 0 2 1 tbl1 00 iDb=0 root=2 write=1 21 Integer 20 3 0 00 r[3]=20 22 Goto 0 2 0 00 }</tcl> <p>Notice how the shell changes the indentation of some opcodes to help show the loop structure of the VDBE program. <h3>Writing results to a file</h3> <p>By default, sqlite3 sends query results to standard output. You can change this using the ".output" and ".once" commands. Just put the name of an output file as an argument to .output and all subsequent query results will be written to that file. Or use the .once command instead of .output and output will only be redirected for the single next command before returning the console. Use .output with no arguments to begin writing to standard output again. For example:</p> <tcl>DisplayCode { sqlite> (((.mode list))) sqlite> (((.separator |))) sqlite> (((.output test_file_1.txt))) sqlite> (((select * from tbl1;))) sqlite> (((.exit))) $ (((cat test_file_1.txt))) hello|10 goodbye|20 $ }</tcl> <p>If the first character of the ".output" or ".once" filename is a pipe symbol ("|") then the remaining characters are treated as a command and the output is sent to that command. This makes it easy to pipe the results of a query into some other process. For example, the "open -f" command on a Mac opens a text editor to display the content that it reads from standard input. So to see the results of a query in a text editor, one could type:</p> <tcl>DisplayCode { sqlite3> (((.once '|open -f'))) sqlite3> (((SELECT * FROM bigTable;))) }</tcl> <h3>Querying the database schema</h3> <p>The sqlite3 program provides several convenience commands that are useful for looking at the schema of the database. There is nothing that these commands do that cannot be done by some other means. These commands are provided purely as a shortcut.</p> <p>For example, to see a list of the tables in the database, you can enter ".tables".</p> <tcl>DisplayCode { sqlite> (((.tables))) tbl1 tbl2 sqlite> }</tcl> <p>The ".tables" command is similar to setting list mode then executing 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 find a query very much like the above.</p> <p>The ".indices" command works in a similar way to list all of the indices for a particular table. The ".indices" command takes a single argument which is the name of the table for which the indices are desired. Last, but not least, is the ".schema" command. With no arguments, the ".schema" command shows the original CREATE TABLE and CREATE INDEX statements that were used to build the current database. If you give the name of a table to ".schema", it shows the original CREATE statement used to make that table and all if its indices. We have:</p> <tcl>DisplayCode { sqlite> (((.schema))) create table tbl1(one varchar(10), two smallint) CREATE TABLE tbl2 ( f1 varchar(30) primary key, f2 text, f3 real ) sqlite> (((.schema tbl2))) CREATE TABLE tbl2 ( f1 varchar(30) primary key, f2 text, f3 real ) sqlite> }</tcl> <p>The ".schema" command accomplishes the same thing as setting list 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 only want 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, the query 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 you to view the schema for some subset of the database.</p> <tcl>DisplayCode { sqlite> (((.schema %abc%))) }</tcl> <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 both appended and prepended and a LIKE clause is added to the query. This allows you to list only those tables that match a particular pattern.</p> <p>The ".databases" command shows a list of all databases open in the current connection. There will always be at least 2. The first one 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> <tcl>DisplayCode { sqlite> (((.databases))) }</tcl> <tcl>hd_fragment csv {CSV import}</tcl> <h3>CSV Import</h3> <p>Use the ".import" command to import CSV (comma separated value) data into an SQLite table. The ".import" command takes two arguments which are the name of the disk file from which CSV data is to be read and the name of the SQLite table into which the CSV data is to be inserted. <p>Note that it is important to set the "mode" to "csv" before running the ".import" command. This is necessary to prevent the command-line shell from trying to interpret the input file text as some other format. <tcl>DisplayCode { sqlite> (((.mode csv))) sqlite> (((.import C:/work/somedata.csv tab1))) }</tcl> <p>There are two cases to consider: (1) Table "tab1" does not previously exist and (2) table "tab1" does already exist. <p>In the first case, when the table does not previously exist, the table is automatically created and the content of the first row of the input CSV file is used to determine the name of all the columns in the table. In other words, if the table does not previously exist, the first row of the CSV file is interpreted to be column names and the actual data starts on the second row of the CSV file. <p>For the second case, when the table already exists, every row of the CSV file, including the first row, is assumed to be actual content. If the CSV file contains an initial row of column labels, that row will be read as data and inserted into the table. To avoid this, make sure that table does not previously exist. <tcl>hd_fragment csvout {CSV export}</tcl> <h3>CSV Export</h3> <p>To export an SQLite table (or part of a table) as CSV, simply set the "mode" to "csv" and then run a query to extract the desired rows of the table. <tcl>DisplayCode { sqlite> (((.header on))) sqlite> (((.mode csv))) sqlite> (((.once c:/work/dataout.csv))) sqlite> (((SELECT * FROM tab1;))) sqlite> (((.system c:/work/dataout.csv))) }</tcl> <p>In the example above, the ".header on" line causes column labels to be printed as the first row of output. This means that the first row of the resulting CSV file will contain column labels. If column labels are not desired, set ".header off" instead. (The ".header off" setting is the default and can be omitted if the headers have not been previously turned on.) <p>The line ".once <i>FILENAME</i>" causes all query output to go into the named file instead of being printed on the console. In the example above, that line causes the CSV content to be written into a file named "C:/work/dataout.csv". <p>The final line of the example (the ".system c:/work/dataout.csv") has the same effect as double-clicking on the c:/work/dataout.csv file in windows. This will typically bring up a spreadsheet program to display the CSV file. That command only works as shown on Windows. The equivalent line on a Mac would be ".system open /work/dataout.csv". On Linux and other unix systems you will need to enter something like ".system libreoffice /work/dataout.csv", substituting your perferred CSV viewing program for "libreoffice". <h3>Converting An Entire Database To An ASCII Text File</h3> <p>Use the ".dump" command to convert the entire contents of a database into a single ASCII text file. This file can be converted back 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> <tcl>DisplayCode { $ (((echo '.dump' | sqlite3 ex1 | gzip -c >ex1.dump.gz))) }</tcl> <p>This generates a file named <b>ex1.dump.gz</b> that contains everything you need to reconstruct the database at a later time, or on another machine. To reconstruct the database, just type:</p> <tcl>DisplayCode { $ (((zcat ex1.dump.gz | sqlite3 ex2))) }</tcl> <p>The text format is pure SQL so you can also use the .dump command to export an SQLite database into other popular SQL database engines. Like this:</p> <tcl>DisplayCode { $ (((createdb ex2))) $ (((sqlite3 ex1 .dump | psql ex2))) }</tcl> <h3>Other Dot Commands</h3> <p>There are many other dot-commands available in the command-line shell. See the ".help" command for a complete list for any particular version and build of SQLite. <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 sqlite3 while redirecting input from the generated command file. This works fine and is appropriate in many circumstances. But as an added convenience, sqlite3 allows a single SQL command to be entered on the command line as a second argument after the database name. When the sqlite3 program is launched with two arguments, the second argument is passed to the SQLite library for processing, the query results are printed on standard output in list mode, and the program exits. This mechanism is designed to make sqlite3 easy to use in conjunction with programs like "awk". For example:</p> <tcl>DisplayCode { $ (((sqlite3 ex1 'select * from tbl1' |))) > ((( awk '{printf "<tr><td>%s<td>%s\n",$1,$2 }'))) <tr><td>hello<td>10 <tr><td>goodbye<td>20 $ }</tcl> <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 source code to the sqlite3 command line interface is in a single file named "shell.c" which you can <a href="http://www.sqlite.org/src/finfo?name=src/shell.c"> download</a> from the SQLite website. Compile this file (together with the [amalgamation | sqlite3 library source code] to generate the executable. For example:</p> <blockquote><pre> gcc -o sqlite3 shell.c sqlite3.c -ldl -lpthread </pre></blockquote>