Skip to contents

duckknit duckknit website

duckknit provides a knitr chunk engine that interfaces with the DuckDB command-line interface. It allows you to write duckdb code chunks in R Markdown and Quarto documents that execute SQL against DuckDB databases, with persistent sessions that carry state across chunks.

Prerequisites

The DuckDB CLI must be installed and available on your PATH. See the DuckDB installation guide for instructions.

You can verify your installation with:

duckdb_sitrep()
#> duckknit situation report
#> ========================
#> 
#> DuckDB CLI
#>   Path:    /opt/homebrew/bin/duckdb 
#>   Version: v1.5.1 (Variegata) 7dbb2e646f 
#> 
#> Sessions: 0 active

Installation

You can install the development version of duckknit from GitHub with:

# install.packages("pak")
pak::pak("rundel/duckknit")

Usage

Load the package to register the duckdb knitr engine:

Then use duckdb chunks in your document. By default, chunks use an in-memory database and each chunk reuses the last active session, so state persists automatically:

```{duckdb}
CREATE TABLE penguins (species TEXT, island TEXT, bill_length DOUBLE);
INSERT INTO penguins VALUES
  ('Adelie',    'Torgersen', 39.1),
  ('Gentoo',    'Biscoe',    47.3),
  ('Chinstrap', 'Dream',     46.5);
```
```{duckdb}
SELECT * FROM penguins ORDER BY bill_length DESC;
```
#> ┌───────────┬───────────┬─────────────┐
#> │  species  │  island   │ bill_length │
#> │  varchar  │  varchar  │   double    │
#> ├───────────┼───────────┼─────────────┤
#> │ Gentoo    │ Biscoe    │        47.3 │
#> │ Chinstrap │ Dream     │        46.5 │
#> │ Adelie    │ Torgersen │        39.1 │
#> └───────────┴───────────┴─────────────┘

Database files

Use the db chunk option to target a specific database file. A new session is created automatically and subsequent chunks without options continue using it:

```{duckdb}
#| db: my.duckdb
CREATE TABLE scores (name TEXT, score INT);
INSERT INTO scores VALUES ('Alice', 95), ('Bob', 87);
```
```{duckdb}
.tables
```
#>  ───── my ────── 
#>  ──── main ───── 
#> ┌───────────────┐
#> │    scores     │
#> │               │
#> │ name  varchar │
#> │ score integer │
#> │               │
#> │    2 rows     │
#> └───────────────┘
```{duckdb}
SELECT * FROM scores;
```
#> ┌─────────┬───────┐
#> │  name   │ score │
#> │ varchar │ int32 │
#> ├─────────┼───────┤
#> │ Alice   │    95 │
#> │ Bob     │    87 │
#> └─────────┴───────┘

Output modes

Use the mode chunk option or the .mode dot-command to control output formatting. Mode changes made with .mode persist for the remainder of the session:

```{duckdb}
#| mode: csv
SELECT * FROM scores;
```
#> name,score
#> Alice,95
#> Bob,87
```{duckdb}
.mode markdown
SELECT * FROM scores;
```
#> | name  | score |
#> |-------|------:|
#> | Alice | 95    |
#> | Bob   | 87    |

Named sessions

The session option lets you give a session an explicit name. This is useful for switching between sessions or creating independent workspaces:

```{duckdb}
#| session: analysis
SELECT 42 as answer;
```
#> ┌────────┐
#> │ answer │
#> │ int32  │
#> ├────────┤
#> │     42 │
#> └────────┘
```{duckdb}
#| session: analysis
SELECT 'still here' as status;
```
#> ┌────────────┐
#> │   status   │
#> │  varchar   │
#> ├────────────┤
#> │ still here │
#> └────────────┘

Managing sessions

Use duckdb_sitrep() to see active sessions. The * marks the last used session:

```{r}
duckdb_sitrep()
```
#> duckknit situation report
#> ========================
#> 
#> DuckDB CLI
#>   Path:    /opt/homebrew/bin/duckdb 
#>   Version: v1.5.1 (Variegata) 7dbb2e646f 
#> 
#> Sessions: 3 active
#>   - analysis (running) -> :memory:  * 
#>   - session-1 (running) -> :memory:  
#>   - session-2 (running) -> /Users/rundel/Desktop/Projects/duckknit/my.duckdb

Use duckknit_list_sessions() to get a tibble of sessions:

duckknit_list_sessions()
#> # A tibble: 3 × 4
#>   session   status  db                                                active
#>   <chr>     <chr>   <chr>                                             <lgl> 
#> 1 analysis  running :memory:                                          TRUE  
#> 2 session-1 running :memory:                                          FALSE 
#> 3 session-2 running /Users/rundel/Desktop/Projects/duckknit/my.duckdb FALSE

You can also kill individual sessions or all sessions at once:

Chunk options

Option Default Description
db ":memory:" Path to a DuckDB database file
session (auto) Session name — reuses if it exists, creates if new. When omitted, the last used session is reused.
mode (not set) DuckDB output mode (csv, markdown, json, etc.)
timeout 30000 Max milliseconds to wait for output

Standard knitr options (echo, eval, results, include, error) are also supported.

Configuration

If the duckdb binary is not on your PATH, you can specify its location:

options(duckknit.duckdb = "/path/to/duckdb")

Disclaimer

This project was vibe coded in an afternoon using Claude Code. The hex logo was generated via ChatGPT.