databow 0.1.0-alpha

A command-line tool for querying databases via ADBC
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

<!--
Copyright 2026 Columnar Technologies Inc.
SPDX-License-Identifier: Apache-2.0
-->

# databow

[![GitHub Release](https://img.shields.io/github/v/release/columnar-tech/databow)](https://github.com/columnar-tech/databow/releases)
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/columnar-tech/databow/ci.yaml)](https://github.com/columnar-tech/databow/actions/workflows/ci.yaml)
[![GitHub License](https://img.shields.io/github/license/columnar-tech/databow?color=blue)](LICENSE)

A command-line tool for querying databases via [ADBC](https://arrow.apache.org/adbc/current/index.html).

## Highlights

- **Multi-database support** - Connect to any database with a compatible ADBC driver
- **Interactive SQL shell** - Execute SQL queries with command history and intuitive navigation
- **Syntax highlighting** - SQL queries highlighted for improved readability
- **Formatted output** - Results displayed in clean, aligned tables with dynamic column width
- **File export** - Export query results to JSON, CSV, or Arrow IPC files
- **Fast and lightweight** - Built in Rust for high performance and minimal resource usage

## Installation

Install from [crates.io](https://crates.io/crates/databow):

```sh
cargo install databow --version 0.1.0-alpha
```

Install from source:

```sh
git clone https://github.com/columnar-tech/databow.git
cargo install --path databow
```

## Getting Started

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

```sh
dbc install duckdb
```

### Interactive Usage

Connect to DuckDB (in-memory):

```sh
databow --driver duckdb
```

Execute SQL queries:

```
> CREATE TABLE penguins AS FROM 'https://blobs.duckdb.org/data/penguins.csv';
┌───────┐
│ Count │
├───────┤
│ 344   │
└───────┘
> SELECT *
. FROM penguins
. LIMIT 5;
┌─────────┬───────────┬────────────────┬───────────────┬───────────────────┬─────────────┬────────┬──────┐
│ species │ island    │ bill_length_mm │ bill_depth_mm │ flipper_length_mm │ body_mass_g │ sex    │ year │
├─────────┼───────────┼────────────────┼───────────────┼───────────────────┼─────────────┼────────┼──────┤
│ Adelie  │ Torgersen │ 39.1           │ 18.7          │ 181               │ 3750        │ male   │ 2007 │
│ Adelie  │ Torgersen │ 39.5           │ 17.4          │ 186               │ 3800        │ female │ 2007 │
│ Adelie  │ Torgersen │ 40.3           │ 18            │ 195               │ 3250        │ female │ 2007 │
│ Adelie  │ Torgersen │ NA             │ NA            │ NA                │ NA          │ NA     │ 2007 │
│ Adelie  │ Torgersen │ 36.7           │ 19.3          │ 193               │ 3450        │ female │ 2007 │
└─────────┴───────────┴────────────────┴───────────────┴───────────────────┴─────────────┴────────┴──────┘
```

### Non-interactive Usage

Execute a query directly and exit:

```sh
databow --driver duckdb --query "SELECT 42 AS the_answer"
```

Execute a query from stdin and exit:

```sh
echo "SELECT 42 AS the_answer" | databow --driver duckdb
```

Execute a query from a file and exit:

```sh
databow --driver duckdb --file select_example.sql
```

Execute a query and output the result to a file:

```sh
databow --driver duckdb --query "SELECT 42 AS the_answer" --output result.json
databow --driver duckdb --query "SELECT 42 AS the_answer" --output result.csv
databow --driver duckdb --query "SELECT 42 AS the_answer" --output result.arrow
```

## Reference

```console
$ databow --help
Query databases via ADBC

Usage: databow [OPTIONS] --driver <driver>

Options:
      --driver <driver>      Driver name
      --uri <uri>            Database uniform resource identifier
      --username <username>  Database user username
      --password <password>  Database user password
      --option <option>      Driver-specific database option
      --mode <mode>          Table display style [default: utf8-compact]
      --query <query>        Execute query and exit
      --file <file>          Read and execute file and exit
      --output <file>        Write result to file
  -h, --help                 Print help
  -V, --version              Print version
```

## License

This project is licensed under [Apache-2.0](LICENSE).