Skip to content

Commit 6e0f104

Browse files
committed
docs: clean up README and docs code examples
1 parent d30dba5 commit 6e0f104

File tree

2 files changed

+41
-64
lines changed

2 files changed

+41
-64
lines changed

README.md

Lines changed: 18 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -29,28 +29,30 @@ cargo install --path adbcli
2929

3030
Install the DuckDB ADBC driver with [dbc](https://docs.columnar.tech/dbc/):
3131

32-
```console
33-
$ dbc install duckdb
32+
```sh
33+
dbc install duckdb
3434
```
3535

3636
### Interactive Usage
3737

3838
Connect to DuckDB (in-memory):
3939

40-
```console
41-
$ adbcli --driver duckdb
40+
```sh
41+
adbcli --driver duckdb
4242
```
4343

4444
Execute SQL queries:
4545

4646
```
47-
CREATE TABLE penguins AS FROM 'https://blobs.duckdb.org/data/penguins.csv';
47+
> CREATE TABLE penguins AS FROM 'https://blobs.duckdb.org/data/penguins.csv';
4848
┌───────┐
4949
│ Count │
5050
├───────┤
5151
│ 344 │
5252
└───────┘
53-
〉SELECT * FROM penguins LIMIT 5;
53+
> SELECT *
54+
. FROM penguins
55+
. LIMIT 5;
5456
┌─────────┬───────────┬────────────────┬───────────────┬───────────────────┬─────────────┬────────┬──────┐
5557
│ species │ island │ bill_length_mm │ bill_depth_mm │ flipper_length_mm │ body_mass_g │ sex │ year │
5658
├─────────┼───────────┼────────────────┼───────────────┼───────────────────┼─────────────┼────────┼──────┤
@@ -66,44 +68,28 @@ Execute SQL queries:
6668

6769
Execute a query directly and exit:
6870

69-
```console
70-
$ adbcli --driver duckdb --query "SELECT 42 AS the_answer"
71-
┌────────────┐
72-
│ the_answer │
73-
├────────────┤
74-
│ 42 │
75-
└────────────┘
71+
```sh
72+
adbcli --driver duckdb --query "SELECT 42 AS the_answer"
7673
```
7774

7875
Execute a query from stdin and exit:
7976

80-
```console
81-
$ echo "SELECT 42 AS the_answer" | adbcli --driver duckdb
82-
┌────────────┐
83-
│ the_answer │
84-
├────────────┤
85-
│ 42 │
86-
└────────────┘
77+
```sh
78+
echo "SELECT 42 AS the_answer" | adbcli --driver duckdb
8779
```
8880

8981
Execute a query from a file and exit:
9082

91-
```console
92-
$ adbcli --driver duckdb --file select_example.sql
93-
┌────┬───────┬────────────┐
94-
│ id │ name │ birthday │
95-
├────┼───────┼────────────┤
96-
│ 1 │ Tom │ 1992-10-16 │
97-
│ 2 │ Alice │ 2001-03-22 │
98-
└────┴───────┴────────────┘
83+
```sh
84+
adbcli --driver duckdb --file select_example.sql
9985
```
10086

10187
Execute a query and output the result to a file:
10288

103-
```console
104-
$ adbcli --driver duckdb --query "SELECT 42 AS the_answer" --output result.json
105-
$ adbcli --driver duckdb --query "SELECT 42 AS the_answer" --output result.csv
106-
$ adbcli --driver duckdb --query "SELECT 42 AS the_answer" --output result.arrow
89+
```sh
90+
adbcli --driver duckdb --query "SELECT 42 AS the_answer" --output result.json
91+
adbcli --driver duckdb --query "SELECT 42 AS the_answer" --output result.csv
92+
adbcli --driver duckdb --query "SELECT 42 AS the_answer" --output result.arrow
10793
```
10894

10995
## Reference

docs/index.md

Lines changed: 23 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -24,28 +24,35 @@ A command-line tool for querying databases via [ADBC](https://arrow.apache.org/a
2424

2525
Install the DuckDB ADBC driver with [dbc](https://docs.columnar.tech/dbc/):
2626

27-
```console
28-
$ dbc install duckdb
27+
```sh
28+
dbc install duckdb
2929
```
3030

31+
!!! note
32+
33+
adbcli can be used to query [many different databases](databases.md).
34+
This guide uses DuckDB for simplicity.
35+
3136
### Interactive Usage
3237

3338
Connect to DuckDB (in-memory):
3439

35-
```console
36-
$ adbcli --driver duckdb
40+
```sh
41+
adbcli --driver duckdb
3742
```
3843

3944
Execute SQL queries:
4045

4146
```
42-
CREATE TABLE penguins AS FROM 'https://blobs.duckdb.org/data/penguins.csv';
47+
> CREATE TABLE penguins AS FROM 'https://blobs.duckdb.org/data/penguins.csv';
4348
┌───────┐
4449
│ Count │
4550
├───────┤
4651
│ 344 │
4752
└───────┘
48-
〉SELECT * FROM penguins LIMIT 5;
53+
> SELECT *
54+
. FROM penguins
55+
. LIMIT 5;
4956
┌─────────┬───────────┬────────────────┬───────────────┬───────────────────┬─────────────┬────────┬──────┐
5057
│ species │ island │ bill_length_mm │ bill_depth_mm │ flipper_length_mm │ body_mass_g │ sex │ year │
5158
├─────────┼───────────┼────────────────┼───────────────┼───────────────────┼─────────────┼────────┼──────┤
@@ -61,42 +68,26 @@ Execute SQL queries:
6168

6269
Execute a query directly and exit:
6370

64-
```console
65-
$ adbcli --driver duckdb --query "SELECT 42 AS the_answer"
66-
┌────────────┐
67-
│ the_answer │
68-
├────────────┤
69-
│ 42 │
70-
└────────────┘
71+
```sh
72+
adbcli --driver duckdb --query "SELECT 42 AS the_answer"
7173
```
7274

7375
Execute a query from stdin and exit:
7476

75-
```console
76-
$ echo "SELECT 42 AS the_answer" | adbcli --driver duckdb
77-
┌────────────┐
78-
│ the_answer │
79-
├────────────┤
80-
│ 42 │
81-
└────────────┘
77+
```sh
78+
echo "SELECT 42 AS the_answer" | adbcli --driver duckdb
8279
```
8380

8481
Execute a query from a file and exit:
8582

86-
```console
87-
$ adbcli --driver duckdb --file select_example.sql
88-
┌────┬───────┬────────────┐
89-
│ id │ name │ birthday │
90-
├────┼───────┼────────────┤
91-
│ 1 │ Tom │ 1992-10-16 │
92-
│ 2 │ Alice │ 2001-03-22 │
93-
└────┴───────┴────────────┘
83+
```sh
84+
adbcli --driver duckdb --file select_example.sql
9485
```
9586

9687
Execute a query and output the result to a file:
9788

98-
```console
99-
$ adbcli --driver duckdb --query "SELECT 42 AS the_answer" --output result.json
100-
$ adbcli --driver duckdb --query "SELECT 42 AS the_answer" --output result.csv
101-
$ adbcli --driver duckdb --query "SELECT 42 AS the_answer" --output result.arrow
89+
```sh
90+
adbcli --driver duckdb --query "SELECT 42 AS the_answer" --output result.json
91+
adbcli --driver duckdb --query "SELECT 42 AS the_answer" --output result.csv
92+
adbcli --driver duckdb --query "SELECT 42 AS the_answer" --output result.arrow
10293
```

0 commit comments

Comments
 (0)