Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install mdsql

It will make the mdsql command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall mdsql uninstalls.

Back to the crate overview.

Readme

mdsql

SQL queries for markdown tables.

Warning: This is an experimental program that modifies files in-place. Always use version control (git) or back up your markdown files before running INSERT or DELETE operations.

Install

cargo install --path .

Usage

# List tables in a file
mdsql tables data.md

# Query first table
mdsql query "SELECT * FROM 0" data.md

# Filter and sort
mdsql query "SELECT name, score FROM 0 WHERE score > 50 ORDER BY score DESC" data.md

# Output as JSON
mdsql query --format json "SELECT * FROM 0" data.md

# Insert a row
mdsql insert "INSERT INTO 0 (name, age, city) VALUES ('Alice', '30', 'NYC')" data.md

# Delete rows
mdsql delete "DELETE FROM 0 WHERE name = 'Alice'" data.md

Supported SQL

SELECT with column filtering and *
WHERE with =, !=, <, >, <=, >=, AND, OR
ORDER BY (ASC/DESC)
LIMIT
INSERT INTO ... VALUES
DELETE FROM ... WHERE

Tables are referenced by 0-based index: FROM 0, INTO 0, etc.

Output Formats

columns (default) - Column-aligned like df -h, unix-friendly
markdown - Markdown table
csv - Comma-separated values
json - JSON array of objects
tsv - Tab-separated values

Roadmap

Split into mdsql library crate and mdsql-cli binary crate
UPDATE ... SET ... WHERE
Aggregate functions (SUM, COUNT, AVG, MIN, MAX)
GROUP BY
Infer table names from preceding markdown headers