.\" Hey, EMACS: -*- nroff -*- .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) .TH SQLITE3 1 "Thu Oct 12 13:53:24 PDT 2023" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: .\" .nh disable hyphenation .\" .hy enable hyphenation .\" .ad l left justify .\" .ad b justify to both left and right margins .\" .nf disable filling .\" .fi enable filling .\" .br insert line break .\" .sp insert n+1 empty lines .\" for manpage-specific macros, see man(7) .SH NAME .B sqlite3 \- A command line interface for SQLite version 3 .SH SYNOPSIS .B sqlite3 .RI [ options ] .RI [ databasefile ] .RI [ SQL ] .SH SUMMARY .PP .B sqlite3 is a terminal-based front-end to the SQLite library that can evaluate queries interactively and display the results in multiple formats. .B sqlite3 can also be used within shell scripts and other applications to provide batch processing features. .SH DESCRIPTION To start a .B sqlite3 interactive session, invoke the .B sqlite3 command and optionally provide the name of a database file. If the database file does not exist, it will be created. If the database file does exist, it will be opened. For example, to create a new database file named "mydata.db", create a table named "memos" and insert a couple of records into that table: .sp $ .B sqlite3 mydata.db .br SQLite version 3.43.2 2023-10-10 13:08:14 .br Enter ".help" for usage hints. .br sqlite> .B CREATE TABLE memos(text, priority INTEGER); .br sqlite> .B INSERT INTO memos VALUES('deliver project description', 10); .br sqlite> .B INSERT INTO memos VALUES('lunch with Christine', 100); .br sqlite> .B SELECT * FROM memos; .br deliver project description|10 .br lunch with Christine|100 .br sqlite> .sp If no database name is supplied, the ATTACH sql command can be used to attach to existing or create new database files. ATTACH can also be used to attach to multiple databases within the same interactive session. This is useful for migrating data between databases, possibly changing the schema along the way. Optionally, a SQL statement or set of SQL statements can be supplied as a single argument. Multiple statements should be separated by semi-colons. For example: .sp $ .B sqlite3 -line mydata.db 'SELECT * FROM memos WHERE priority > 20;' .br text = lunch with Christine .br priority = 100 .br .sp .SS SQLITE META-COMMANDS .PP The interactive interpreter offers a set of meta-commands that can be used to control the output format, examine the currently attached database files, or perform administrative operations upon the attached databases (such as rebuilding indices). Meta-commands are always prefixed with a dot (.). A list of available meta-commands can be viewed at any time by issuing the '.help' command. For example: .sp sqlite> .B .help .nf .tr %. ... .sp .fi The available commands differ by version and build options, so they are not listed here. Please refer to your local copy for all available options. .SH OPTIONS .B sqlite3 has the following options: .TP .BI \-A\ ARGS... Run .I .archive ARGS and exit .TP .B \-append Append the database to the end of the file. .TP .B \-ascii Set output mode to 'ascii'. .TP .B \-bail Stop after hitting an error. .TP .B \-batch Force batch I/O. .TP .B \-box Set output mode to 'box'. .TP .B \-column Query results will be displayed in a table like form, using whitespace characters to separate the columns and align the output. .TP .BI \-cmd\ command run .I command before reading stdin .TP .B \-csv Set output mode to CSV (comma separated values). .TP .B \-deserialize Open the database using sqlite3_deserialize() .TP .B \-echo Print commands before execution. .TP .BI \-init\ file Read and execute commands from .I file , which can contain a mix of SQL statements and meta-commands. .TP .B \-[no]header Turn headers on or off. .TP .B \-help Show help on options and exit. .TP .BI \-hexkey\ key Open database with hexadecimal encryption key. .TP .B \-html Query results will be output as simple HTML tables. .TP .B \-interactive Force interactive I/O. .TP .BI \-key\ key Open database with raw encryption key .I key .TP .B \-json Set output mode to 'json'. .TP .B \-line Query results will be displayed with one value per line, rows separated by a blank line. Designed to be easily parsed by scripts or other programs .TP .B \-list Query results will be displayed with the separator (|, by default) character between each field value. The default. .TP .BI \-lookaside\ "size n" Use .I n entries of .I size bytes for lookaside memory .TP .B \-markdown Set output mode to 'markdown'. .TP .BI \-maxsize\ N Limits size of a -deserialize database to .I N bytes .TP .B -memtrace Trace all memory allocations. .TP .BI \-newline\ sep Set output row separator. Default is '\\n'. .TP .B -nofollow Refuse to open paths containing symbolic links. .TP .BI \-nonce\ string Set the safe-mode escape nonce to .I string .TP .BI \-nullvalue\ string Set string used to represent NULL values. Default is '' (empty string). .TP .B -quote Set output mode to quote. .TP .B -readonly Open the database read-only. .TP .BI \-safe Enable safe-mode. .TP .BI \-separator\ separator Set output field separator. Default is '|'. .TP .B \-stats Print memory stats before each finalize. .TP .BI \-textkey\ PASSPHRASE Text to be hashed into the encryption key. .TP .B \-table Set output mode to 'table'. .TP .B \-tabs Set output mode to 'tabs'. .TP .B \-version Show SQLite version. .TP .BI \-vfs\ name Use .I name as the default VFS. .TP .B \-zip Open the file as a zip archive. .SH INIT FILE .B sqlite3 reads an initialization file to set the configuration of the interactive environment. Throughout initialization, any previously specified setting can be overridden. The sequence of initialization is as follows: o The default configuration is established as follows: .sp .nf .cc | mode = LIST separator = "|" main prompt = "sqlite> " continue prompt = " ...> " |cc . .sp .fi o If the file .B ${XDG_CONFIG_HOME}/sqlite3/sqliterc or .B ~/.sqliterc exists, the first of those to be found is processed during startup. It should generally only contain meta-commands. o If the -init option is present, the specified file is processed. o All other command line options are processed. .SH SEE ALSO https://sqlite.org/cli.html .br https://sqlite.org/fiddle (a WebAssembly build of the CLI app) .br The sqlite3-doc package. .SH AUTHOR This manual page was originally written by Andreas Rottmann , for the Debian GNU/Linux system (but may be used by others). It was subsequently revised by Bill Bumgarner , Laszlo Boszormenyi , Scott Perry , and the sqlite3 developers.