From 8982190a59b74f5d15ea5896f957fc7ddcbd27d9 Mon Sep 17 00:00:00 2001 From: Sam Ansmink Date: Thu, 7 Nov 2024 16:24:37 +0100 Subject: [PATCH] update readme --- README.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a5497b1..a975d74 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ # DuckDB Rust extension template -This is an experimental template for Rust based extensions based on the C Extension API of DuckDB. +This is an **experimental** template for Rust based extensions based on the C Extension API of DuckDB. The goal is to +turn this eventually into a stable basis for pure-Rust DuckDB extensions that can be submitted to the Community extensions +repository + +Features: +- No DuckDB build required +- No C++ or C code required +- CI/CD chain preconfigured +- (Coming soon) Works with community extensions ## Cloning @@ -55,6 +63,27 @@ or for the *release* build: make test_release ``` +### Version switching +Testing with different DuckDB versions is really simple: + +First, run +``` +make clean_all +``` +to ensure the previous `make configure` step is deleted. + +Then, run +``` +DUCKDB_TEST_VERSION=v1.1.2 make configure +``` +to select a different duckdb version to test with + +Finally, build and test with +``` +make debug +make test_debug +``` + ### Known issues This is a bit of a footgun, but the extensions produced by this template may (or may not) be broken on windows on python3.11 with the following error on extension load: