Skip to main content

Module connection

Module connection 

Source
Expand description

Connection — version-agnostic extension registration facade.

Connection wraps the duckdb_connection and duckdb_database handles provided to your extension during initialization. It implements the Registrar trait, which provides a uniform API for registering all extension components that works identically across DuckDB 1.4.x and 1.5.x.

§Obtaining a Connection

Use init_extension_v2 or the entry_point_v2! macro. These pass a &Connection to your registration callback instead of the raw duckdb_connection.

use quack_rs::connection::{Connection, Registrar};
use quack_rs::error::ExtensionError;
use quack_rs::scalar::ScalarFunctionBuilder;

unsafe fn register_all(reg: &impl Registrar) -> Result<(), ExtensionError> {
    let builder = ScalarFunctionBuilder::map1("my_fn", |x: i64| x + 1)?;
    unsafe { reg.register_typed_scalar(builder) }
}

quack_rs::entry_point_v2!(my_extension_init_c_api, |con| {
    unsafe { register_all(con) }
});

§DuckDB version compatibility

Connection and Registrar provide a stable API across DuckDB 1.4.x, 1.5.x and 2.0.0. The underlying C API version string ("v1.2.0") loads in every one of them: E2E tests confirm it for DuckDB 1.4.4, 1.5.0 and 2.0.0, and 1.5.6 and 2.0.0, which declare v1.5.6, accept any earlier C API version (their VersioningUtils::IsSupportedCAPIVersion).

When a future DuckDB release changes the C API version or adds new registration surface, additional methods will be added to Connection behind a version-specific feature flag (e.g. duckdb-1-5).

Structs§

Connection
Wraps the duckdb_connection and duckdb_database provided to your extension at load time.

Traits§

Registrar
Version-agnostic trait for registering DuckDB extension components.