better-duck-core 0.1.0-beta.3

Rust DuckDB client with Diesel ORM support
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

// SPDX-License-Identifier: MIT OR Apache-2.0
//! `better-duck-core` — a safe, low-level Rust wrapper around the
//! [DuckDB](https://duckdb.org) C API (`libduckdb-sys`).
//!
//! This crate provides:
//! - A high-level [`connection::Connection`] for opening databases and executing SQL.
//! - Low-level raw types (`RawConnection`, `DuckResult`, `DuckRow`) for advanced use.
//! - Type conversion traits ([`types::DuckDialect`], [`types::appendable::AppendAble`]) for
//!   mapping between Rust types and DuckDB values.

pub extern crate libduckdb_sys;
/// Re-export of the raw `libduckdb_sys` FFI bindings.
pub use libduckdb_sys as ffi;

/// Async facade over [`connection::Connection`], gated by the `async` feature.
#[cfg(feature = "async")]
pub mod asynchronous;
/// DuckDB database configuration.
pub mod config;
/// High-level DuckDB connection type.
pub mod connection;
/// A shared, cloneable handle to an open DuckDB database.
pub mod database;
/// Error types returned by this crate.
pub mod error;
mod helpers;
/// An `r2d2` connection pool backed by a shared [`Database`](database::Database).
#[cfg(feature = "pool")]
pub mod pool;
mod raw;
/// An owned, thread-safe, fully materialized query result.
pub mod result_set;
/// DuckDB type system and value conversion traits.
pub mod types;
/// User-defined DuckDB functions: scalar functions and table functions.
#[cfg(feature = "udf")]
pub mod udf;

/// Async facade over [`connection::Connection`].
#[cfg(feature = "async")]
pub use asynchronous::AsyncConnection;
/// Async facade over [`Database`].
#[cfg(feature = "async")]
pub use asynchronous::AsyncDatabase;
/// Async facade over [`pool::Pool`].
#[cfg(all(feature = "async", feature = "pool"))]
pub use asynchronous::AsyncPool;

/// Registers a plain Rust function as a DuckDB scalar function. See [`udf`].
#[cfg(feature = "udf")]
pub use better_duck_macros::duckdb_scalar;
/// Registers a plain Rust function as a DuckDB table function. See [`udf`].
#[cfg(feature = "udf")]
pub use better_duck_macros::duckdb_table_function;
/// DuckDB database configuration.
pub use config::{AccessMode, Config, DefaultNullOrder, DefaultOrder};
/// A shared, cloneable handle to an open DuckDB database.
pub use database::Database;
/// A DuckDB appender for bulk-inserting rows into a table.
pub use raw::appender::Appender;
/// A fully iterable DuckDB query result.
pub use raw::result::DuckResult;
/// A single row from a DuckDB query result.
pub use raw::row::DuckRow;
/// A prepared statement suitable for caching and re-execution.
pub use raw::statement::CachedStatement;
/// An owned, thread-safe, fully materialized query result.
pub use result_set::ResultSet;
/// Trait for binding values to DuckDB prepared statements and appenders.
pub use types::appendable::AppendAble;
/// A calendar date value for use without the `chrono` feature.
#[cfg(not(feature = "chrono"))]
pub use types::date_native::DuckDate;
/// A time-of-day value for use without the `chrono` feature.
#[cfg(not(feature = "chrono"))]
pub use types::date_native::DuckTime;