haybarn 1.10505.0-rc.1

Haybarn — an ergonomic Rust wrapper for the Haybarn engine, a derived distribution of DuckDB (powered by DuckDB)
Documentation 
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

# haybarn-rust

[![Latest Version](https://img.shields.io/crates/v/haybarn.svg)](https://crates.io/crates/haybarn)
[![Documentation](https://img.shields.io/badge/docs.rs-haybarn-orange)](https://docs.rs/haybarn)
[![MIT License](https://img.shields.io/crates/l/haybarn.svg)](LICENSE)

`haybarn` is an ergonomic Rust wrapper for **Haybarn** — an independent derived
distribution of DuckDB, published by Query Farm LLC. It is a rebrand of the
upstream [`duckdb-rs`](https://github.com/duckdb/duckdb-rs) crate and is
intentionally **ABI-compatible** with DuckDB: the C API, the `duckdb::` C++
namespace, headers, and the `DUCKDB_VERSION` are all preserved. The only
differences are the published crate names and the embedded extension trust root.

You can use it to:

- Query Haybarn with type-safe bindings and an API inspired by
  [rusqlite](https://github.com/rusqlite/rusqlite).
- Read and write Arrow, Parquet, JSON, and CSV formats natively.
- Build Haybarn extensions in Rust with custom scalar and table functions.

## Crates

| Crate | Replaces | Purpose |
|---|---|---|
| [`haybarn`](https://crates.io/crates/haybarn) | `duckdb` | ergonomic wrapper |
| [`libhaybarn-sys`](https://crates.io/crates/libhaybarn-sys) | `libduckdb-sys` | low-level C-API FFI |
| [`haybarn-loadable-macros`](https://crates.io/crates/haybarn-loadable-macros) | `duckdb-loadable-macros` | extension proc-macros |

Versioning follows upstream: the crate version encodes the engine version as
`1.MAJOR_MINOR_PATCH.x`, so `1.10503.x` corresponds to the **1.5.3** engine.

## Quickstart

Add the `haybarn` crate with the `bundled` feature. **`bundled` is the supported
path for Haybarn** — it compiles the Haybarn engine from a vendored amalgamation
that carries the Haybarn extension trust root (see [Extension trust](#extension-trust)):

```shell
cargo new my-app && cd my-app
cargo add haybarn -F bundled
```

```rust
use haybarn::{params, Connection, Result};

struct Bale {
    id: i32,
    label: String,
}

fn main() -> Result<()> {
    let conn = Connection::open_in_memory()?;
    conn.execute_batch(
        "CREATE TABLE bales (id INTEGER PRIMARY KEY, label TEXT);
         INSERT INTO bales VALUES (1, 'north field'), (2, 'south field');",
    )?;

    let bales = conn
        .prepare("FROM bales ORDER BY id")?
        .query_map([], |row| {
            Ok(Bale { id: row.get(0)?, label: row.get(1)? })
        })?
        .collect::<Result<Vec<_>>>()?;

    for b in bales {
        println!("{}: {}", b.id, b.label);
    }
    Ok(())
}
```

## Migrating from `duckdb-rs`

Because `haybarn` is ABI-compatible, existing `duckdb-rs` code can switch with a
single `Cargo.toml` line and **no source changes** — Cargo's package-rename keeps
the import name as `duckdb`:

```toml
[dependencies]
duckdb = { package = "haybarn", version = "1.10503", features = ["bundled"] }
```

Every `use duckdb::...` keeps working. Fresh projects can instead depend on
`haybarn` directly and write `use haybarn::...`.

> **Loadable-extension authors** (the experimental `loadable-extension` feature)
> must import the crate as `haybarn`, because `haybarn-loadable-macros` emits
> `::haybarn::ffi` paths. The `package = "haybarn"` rename trick does not cover
> that case.

## Extension trust

The `bundled` build compiles an amalgamation regenerated from the
[Haybarn engine](https://github.com/Query-farm-haybarn/haybarn). It embeds the
**single Haybarn RSA trust root** for both core and community extensions and the
`haybarn-extensions.query.farm` repositories. DuckDB-signed extensions will not
load, by design.

> **Non-bundled paths are not yet wired for Haybarn.** The system-library
> discovery (`pkg-config` / `vcpkg`) and `DUCKDB_DOWNLOAD_LIB` paths inherited
> from upstream still reference DuckDB. Use `bundled` until those are rebranded.

## License & trademark

Licensed under [MIT](LICENSE), preserved verbatim from upstream `duckdb-rs`.
See [NOTICE](NOTICE) for the list of modifications.

Haybarn is **independent of and not endorsed by the DuckDB Foundation**.
DuckDB is a trademark of the DuckDB Foundation
(<https://duckdb.org/trademark_guidelines>). "Haybarn, powered by DuckDB."

The original `duckdb-rs` project lives at
<https://github.com/duckdb/duckdb-rs>.