Synopsis
sqlite3 [options] [databasefile] [SQL]
Summary
sqlite3 is a terminal-based front-end to the SQLite library that can evaluate queries interactively and display the results in multiple formats. sqlite3 can also be used within shell scripts and other applications to provide batch processing features.
Description
To start a sqlite3 interactive session, invoke the 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:
$ sqlite3 mydata.db SQLite version 3.43.2 2023-10-10 13:08:14 Enter ".help" for usage hints. sqlite> CREATE TABLE memos(text, priority INTEGER); sqlite> INSERT INTO memos VALUES('deliver project description', 10); sqlite> INSERT INTO memos VALUES('lunch with Christine', 100); sqlite> SELECT * FROM memos; deliver project description|10 lunch with Christine|100 sqlite>
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:
$ sqlite3 -line mydata.db 'SELECT * FROM memos WHERE priority > 20;' text = lunch with Christine priority = 100
SQLITE META-COMMANDS 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:
sqlite> .help
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.
Options
sqlite3 has the following options:
-A ARGS... Run .archive ARGS and exit
-append Append the database to the end of the file.
-ascii Set output mode to 'ascii'.
-bail: Stop after hitting an error.
-batch Force batch I/O.
-box: Set output mode to 'box'.
-column Query results will be displayed in a table like form, using whitespace characters to separate the columns and align the output.
-cmd command run command before reading stdin
-csv: Set output mode to CSV (comma separated values).
-deserialize Open the database using sqlite3_deserialize()
-echo: Print commands before execution.
-init file Read and execute commands from file , which can contain a mix of SQL statements and meta-commands.
-[no]header Turn headers on or off.
-help: Show help on options and exit.
-hexkey key Open database with hexadecimal encryption key.
-html: Query results will be output as simple HTML tables.
-interactive Force interactive I/O.
-key key Open database with raw encryption key key
-json: Set output mode to 'json'.-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-list: Query results will be displayed with the separator (|, by default) character between each field value. The default.
-lookaside size n Use n entries of size bytes for lookaside memory
-markdown Set output mode to 'markdown'.
-maxsize N Limits size of a -deserialize database to N bytes
-memtrace Trace all memory allocations.
-newline sep Set output row separator. Default is '\n'.
-nofollow Refuse to open paths containing symbolic links.
-nonce string Set the safe-mode escape nonce to string
-nullvalue string Set string used to represent NULL values. Default is '' (empty string).
-quote Set output mode to quote.
-readonly Open the database read-only.
-safe: Enable safe-mode.
-separator separator Set output field separator. Default is '|'.
-stats Print memory stats before each finalize.
-textkey PASSPHRASE Text to be hashed into the encryption key.
-table Set output mode to 'table'.
-tabs: Set output mode to 'tabs'.
-version Show SQLite version.
-vfs name Use name as the default VFS.
-zip: Open the file as a zip archive.
Init File
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:
mode = LIST separator = "|" main prompt = "sqlite> " continue prompt = " ...> "
o If the file ${XDG_CONFIG_HOME}/sqlite3/sqliterc or ~/.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.
See Also
https://sqlite.org/cli.html https://sqlite.org/fiddle (a WebAssembly build of the CLI app) The sqlite3-doc package.
Author
This manual page was originally written by Andreas Rottmann rotty@debian.org, for the Debian GNU/Linux system (but may be used by others). It was subsequently revised by Bill Bumgarner bbum@mac.com, Laszlo Boszormenyi gcs@debian.hu, Scott Perry sqlite@numist.net, and the sqlite3 developers.
Thu Oct 12 13:53:24 PDT 2023 SQLITE3(1)