diff --git a/docs/index.md b/docs/index.md index c18e4a8..90f9eba 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,8 +17,10 @@ pip install dclient ### As a Datasette plugin -If you also have Datasette installed in the same environment it will register itself as a command plugin. - +If you also have Datasette installed in the same environment it will register itself as a command plugin: +```bash +datasette install dclient +``` This means you can run any of these commands using `datasette client` instead, like this: ```bash datasette client --help @@ -29,58 +31,6 @@ You can install it into Datasette this way using: ```bash datasette install dclient ``` -## 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" - } -] -``` - -### dclient query --help - -``` -Usage: dclient query [OPTIONS] URL SQL - - Run a SQL query against a Datasette database URL - - Returns a JSON array of objects - -Options: - -t, --token TEXT API token - --help Show this message and exit. - -``` - - ## Contents @@ -88,6 +38,7 @@ Options: --- maxdepth: 3 --- +queries aliases authentication ``` diff --git a/docs/queries.md b/docs/queries.md new file mode 100644 index 0000000..fa3123e --- /dev/null +++ b/docs/queries.md @@ -0,0 +1,51 @@ +# 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" + } +] +``` + +## dclient query --help + +``` +Usage: dclient query [OPTIONS] URL SQL + + Run a SQL query against a Datasette database URL + + Returns a JSON array of objects + +Options: + -t, --token TEXT API token + --help Show this message and exit. + +``` +