Expand description
What each command in the table actually does.
Invariant: every one of these drives the shell. Some run SQL through
Shell::collect, some run a dot command through Shell and collect what it
printed, and none of them touches the engine directly. That is the same
constraint the shell itself carries, one level up, and it is what makes the
416-case differential probe cover this surface too.
Where a verb is a thin wrapper over a dot command, it is a deliberate thin
wrapper: .dump and .import are the reference’s own, they have been
compared against sqlite3 byte for byte, and a second implementation here
would be a second set of quoting rules. Where a verb produces a table
instead - tables, describe, capabilities - it is because a caller that
is a program wants rows rather than a paragraph.
Functions§
- analyze
analyze: gathers the statistics the planner reads.- backup
backup: copies the database to a file.- batch
batch: runs several statements as one transaction.- capabilities
capabilities: what the engine says it does, checked in both directions.- checkpoint
checkpoint: writes the log back into the database file.- create
create: makes a new database file.- databases
databases: what is attached, and the file behind each.- decrypt
decrypt: writes a plaintext copy of an encrypted database.- describe
describe: everything about one table, in one call.- dump
dump: the database as the SQL that rebuilds it.- encrypt
encrypt: writes an encrypted copy of a plaintext database.- exec
exec: runs one statement for its effect.- explain
explain: the query plan, drawn the way the shell draws it.- export
export: writes rows out in a chosen format.- functions
functions: the SQL functions this engine answers.- help
help: the command table, or one entry from it.- import
import: reads a delimited file into a table.- indexes
indexes: the indexes in the database, and what each is on.- integrity_
check integrity-check: reads every page and says whether it holds together.- mcp_
placeholder - The stand-in for
mcp. - migrate
migrate: brings a SQLite file, a running server, or a legacy index into this engine.- query
query: runs a statement that returns rows.- rekey
rekey: changes the key of an encrypted database.- restore
restore: replaces this database’s contents from a file.- run_
input run: runs shell input, dot commands included, and returns what it printed.- schema
schema: theCREATEstatements, as the shell writes them.- search
search: full-text and hybrid retrieval, without writing the idiom.- shell_
placeholder - The stand-in for
shell. - stats
stats: what the page cache and the file are doing.- tables
tables: the tables and views in the database.- value_
to_ json - Turns one engine value into the JSON a result carries.
- vector_
search vector-search: the nearest rows to a vector, by cosine distance.- version
version: what this build is.