CLI Reference
query
Run ad hoc SQL queries against the project database.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Run ad hoc SQL queries against the project database.
sqb --project-dir <path> query "SELECT * FROM dev.fact_orders LIMIT 5"
sqb --project-dir <path> query --file my_query.sql
| Flag | Description |
|---|---|
sql | SQL to execute (positional argument) |
--file | Read SQL from a file instead of the command line |
--format | Output format: long (default), table, json, or csv |
--limit | Maximum rows to return (default: 20) |
--no-limit | Disable the row limit |
-[ RECORD 1 ]---------------------------+
order_id | 1
customer_id | 100
status | completed
-[ RECORD 2 ]---------------------------+
order_id | 2
customer_id | 200
status | completed
2 rows
order_id | customer_id | status
-------- | ----------- | ---------
1 | 100 | completed
2 | 200 | completed
2 rows
[{"order_id": 1, "customer_id": 100, "status": "completed"}]
order_id,customer_id,status
1,100,completed
2,200,completed
# Quick inspection with default format
sqb query "SELECT * FROM dev.fact_orders"
# Table format with higher limit
sqb query "SELECT * FROM dev.dim_customers" --format table --limit 50
# Export to JSON
sqb query "SELECT * FROM dev.daily_revenue" --format json --no-limit
# Run SQL from a file
sqb query --file debug_query.sql