mirror of
https://github.com/simonw/dclient.git
synced 2026-07-28 20:04:32 +02:00
186 lines
3.8 KiB
Markdown
186 lines
3.8 KiB
Markdown
# dclient
|
|
|
|
[](https://pypi.org/project/dclient/)
|
|
[](https://github.com/simonw/dclient/releases)
|
|
[](https://github.com/simonw/dclient/actions?query=workflow%3ATest)
|
|
[](https://github.com/simonw/dclient/blob/master/LICENSE)
|
|
|
|
A client CLI utility for Datasette instances
|
|
|
|
## Installation
|
|
|
|
Install this tool using `pip`:
|
|
|
|
pip install dclient
|
|
|
|
## Running queries
|
|
|
|
You can run SQL queries against a Datasette instance like so:
|
|
|
|
```
|
|
$ 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"
|
|
}
|
|
]
|
|
```
|
|
|
|
### 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 SQL
|
|
|
|
Run a SQL query against a Datasette database URL
|
|
|
|
Returns a JSON array of objects
|
|
|
|
Options:
|
|
--help Show this message and exit.
|
|
|
|
```
|
|
<!-- [[[end]]] -->
|
|
|
|
## Aliases
|
|
|
|
You can assign an alias to a Datasette database using the `dclient alias` command:
|
|
|
|
dclient alias add content https://datasette.io/content
|
|
|
|
You can list aliases with `dclient alias list`:
|
|
|
|
$ dclient alias list
|
|
content = https://datasette.io/content
|
|
|
|
Once registered, you can pass an alias to commands such as `dclient query`:
|
|
|
|
dclient query content "select * from news limit 1"
|
|
|
|
### dclient alias --help
|
|
|
|
<!-- [[[cog
|
|
import cog
|
|
result = runner.invoke(cli.cli, ["alias", "--help"])
|
|
help = result.output.replace("Usage: cli", "Usage: dclient")
|
|
cog.out(
|
|
"```\n{}\n```".format(help)
|
|
)
|
|
]]] -->
|
|
```
|
|
Usage: dclient alias [OPTIONS] COMMAND [ARGS]...
|
|
|
|
Manage aliases for different instances
|
|
|
|
Options:
|
|
--help Show this message and exit.
|
|
|
|
Commands:
|
|
add Add an alias
|
|
list List aliases
|
|
remove Remove an alias
|
|
|
|
```
|
|
<!-- [[[end]]] -->
|
|
|
|
### dclient alias list --help
|
|
|
|
<!-- [[[cog
|
|
import cog
|
|
result = runner.invoke(cli.cli, ["alias", "list", "--help"])
|
|
help = result.output.replace("Usage: cli", "Usage: dclient")
|
|
cog.out(
|
|
"```\n{}\n```".format(help)
|
|
)
|
|
]]] -->
|
|
```
|
|
Usage: dclient alias list [OPTIONS]
|
|
|
|
List aliases
|
|
|
|
Options:
|
|
--json Output raw JSON
|
|
--help Show this message and exit.
|
|
|
|
```
|
|
<!-- [[[end]]] -->
|
|
|
|
### dclient alias add --help
|
|
|
|
<!-- [[[cog
|
|
import cog
|
|
result = runner.invoke(cli.cli, ["alias", "add", "--help"])
|
|
help = result.output.replace("Usage: cli", "Usage: dclient")
|
|
cog.out(
|
|
"```\n{}\n```".format(help)
|
|
)
|
|
]]] -->
|
|
```
|
|
Usage: dclient alias add [OPTIONS] NAME URL
|
|
|
|
Add an alias
|
|
|
|
Options:
|
|
--help Show this message and exit.
|
|
|
|
```
|
|
<!-- [[[end]]] -->
|
|
|
|
### dclient alias remove --help
|
|
|
|
<!-- [[[cog
|
|
import cog
|
|
result = runner.invoke(cli.cli, ["alias", "remove", "--help"])
|
|
help = result.output.replace("Usage: cli", "Usage: dclient")
|
|
cog.out(
|
|
"```\n{}\n```".format(help)
|
|
)
|
|
]]] -->
|
|
```
|
|
Usage: dclient alias remove [OPTIONS] NAME
|
|
|
|
Remove an alias
|
|
|
|
Options:
|
|
--help Show this message and exit.
|
|
|
|
```
|
|
<!-- [[[end]]] -->
|
|
|
|
## Development
|
|
|
|
To contribute to this tool, first checkout the code. Then create a new virtual environment:
|
|
|
|
cd dclient
|
|
python -m venv venv
|
|
source venv/bin/activate
|
|
|
|
Now install the dependencies and test dependencies:
|
|
|
|
pip install -e '.[test]'
|
|
|
|
To run the tests:
|
|
|
|
pytest
|