mirror of
https://github.com/simonw/dclient.git
synced 2026-08-01 23:14:12 +02:00
02dd3ae9ca- Update README.md with new commands summary and uv development workflow - Add docs/exploring.md covering databases, tables, schema, rows, get commands with filtering, sorting, pagination, and output format examples - Add docs/writing.md covering create-table, upsert, update, delete, drop - Update docs/queries.md with output format options (--csv, --tsv, --nl, --table) - Update docs/inserting.md with cross-references to upsert/update - Update docs/index.md toctree to include new pages - Regenerate all cog --help blocks with current command signatures https://claude.ai/code/session_01DoiJf9Gbvbw2asN9yvP6dx
91 lines
1.9 KiB
Markdown
91 lines
1.9 KiB
Markdown
# Running queries
|
|
|
|
You can run SQL queries against a Datasette instance like this:
|
|
|
|
```bash
|
|
dclient query https://latest.datasette.io/fixtures "select * from facetable limit 1"
|
|
```
|
|
Output:
|
|
```json
|
|
[
|
|
{
|
|
"pk": 1,
|
|
"created": "2019-01-14 08:00:00",
|
|
"planet_int": 1,
|
|
"on_earth": 1,
|
|
"state": "CA",
|
|
"_city_id": 1,
|
|
"_neighborhood": "Mission",
|
|
"tags": "[\"tag1\", \"tag2\"]",
|
|
"complex_array": "[{\"foo\": \"bar\"}]",
|
|
"distinct_some_null": "one",
|
|
"n": "n1"
|
|
}
|
|
]
|
|
```
|
|
|
|
## Output formats
|
|
|
|
Query results default to JSON. Use these flags for other formats:
|
|
|
|
- `--csv` — CSV
|
|
- `--tsv` — TSV
|
|
- `--nl` — Newline-delimited JSON (one JSON object per line)
|
|
- `--table` — Formatted text table
|
|
|
|
```bash
|
|
dclient query https://latest.datasette.io/fixtures \
|
|
"select state, count(*) as n from facetable group by state" --table
|
|
```
|
|
Output:
|
|
```
|
|
state n
|
|
----- --
|
|
CA 10
|
|
MI 4
|
|
MO 1
|
|
```
|
|
|
|
Export as CSV:
|
|
```bash
|
|
dclient query https://latest.datasette.io/fixtures \
|
|
"select * from facetable limit 5" --csv > results.csv
|
|
```
|
|
|
|
## dclient query --help
|
|
<!-- [[[cog
|
|
import cog
|
|
from dclient import cli
|
|
from click.testing import CliRunner
|
|
runner = CliRunner()
|
|
result = runner.invoke(cli.cli, ["query", "--help"])
|
|
help = result.output.replace("Usage: cli", "Usage: dclient")
|
|
cog.out(
|
|
"```\n{}\n```".format(help)
|
|
)
|
|
]]] -->
|
|
```
|
|
Usage: dclient query [OPTIONS] URL_OR_ALIAS SQL
|
|
|
|
Run a SQL query against a Datasette database URL
|
|
|
|
Returns a JSON array of objects
|
|
|
|
Example usage:
|
|
|
|
dclient query \
|
|
https://datasette.io/content \
|
|
'select * from news limit 10'
|
|
|
|
Options:
|
|
--token TEXT API token
|
|
-v, --verbose Verbose output: show HTTP request
|
|
--csv Output as CSV
|
|
--tsv Output as TSV
|
|
--json Output as JSON (default)
|
|
--nl Output as newline-delimited JSON
|
|
--table Output as text table
|
|
--help Show this message and exit.
|
|
|
|
```
|
|
<!-- [[[end]]] -->
|