add duckdb extension

Author: joseph-isaacs

.gitignore

@@ -6,3 +6,7 @@ duckdb_unittest_tempdir/
 testext
 test/python/__pycache__/
 .Rhistory
+compile_commands.json
+
+#proto gen folder
+gen/

.gitmodules

@@ -1,8 +1,8 @@
-[submodule "duckdb"]
-	path = duckdb
-	url = https://github.com/duckdb/duckdb
-	branch = main
 [submodule "extension-ci-tools"]
 	path = extension-ci-tools
 	url = https://github.com/duckdb/extension-ci-tools
+	branch = main
+[submodule "vortex"]
+	path = vortex
+	url = https://github.com/spiraldb/vortex
 	branch = main

CMakeLists.txt

@@ -1,30 +1,93 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.22)
 
-# Set extension name here
-set(TARGET_NAME quack)
+set(TARGET_NAME vortex)
+project(${TARGET_NAME}_project)
 
-# DuckDB's extension distribution supports vcpkg. As such, dependencies can be added in ./vcpkg.json and then
-# used in cmake with find_package. Feel free to remove or replace with other dependencies.
-# Note that it should also be removed from vcpkg.json to prevent needlessly installing it..
-find_package(OpenSSL REQUIRED)
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+set(CMAKE_CXX_STANDARD 20)
+
+include(FetchContent)
+FetchContent_Declare(
+    Corrosion
+    GIT_REPOSITORY https://github.com/corrosion-rs/corrosion.git
+    GIT_TAG v0.5.1
+)
+FetchContent_Declare(
+    vcpkg
+    GIT_REPOSITORY https://github.com/microsoft/vcpkg.git
+    GIT_TAG 2025.03.19
+)
+FetchContent_MakeAvailable(Corrosion)
+FetchContent_MakeAvailable(vcpkg)
+
+# Install vcpkg dependencies.
+execute_process(
+    COMMAND bash ./bootstrap-vcpkg.sh -disableMetrics
+    WORKING_DIRECTORY "${vcpkg_SOURCE_DIR}"
+    RESULT_VARIABLE VCPKG_BOOTSTRAP_RESULT
+)
+set(VCPKG_INSTALL_DIR "${CMAKE_BINARY_DIR}/vcpkg_installed")
+file(MAKE_DIRECTORY "${VCPKG_INSTALL_DIR}")
+execute_process(
+    COMMAND "${vcpkg_SOURCE_DIR}/vcpkg" install --no-print-usage --x-manifest-root=${CMAKE_CURRENT_SOURCE_DIR}/vcpkg --x-install-root=${VCPKG_INSTALL_DIR}
+    WORKING_DIRECTORY "${vcpkg_SOURCE_DIR}"
+)
+
+if (APPLE AND CMAKE_SYSTEM_PROCESSOR MATCHES "arm64")
+    set(CMAKE_PREFIX_PATH ${VCPKG_INSTALL_DIR}/arm64-osx)
+elseif (APPLE)
+    set(CMAKE_PREFIX_PATH ${VCPKG_INSTALL_DIR}/x64-osx)
+elseif (UNIX AND NOT APPLE)
+    set(CMAKE_PREFIX_PATH ${VCPKG_INSTALL_DIR}/x64-linux)
+endif ()
+
+find_package(Catch2 CONFIG REQUIRED)
+find_package(Protobuf CONFIG REQUIRED)
+if (APPLE)
+    find_library(CORE_FOUNDATION_FRAMEWORK CoreFoundation)
+    find_library(SECURITY_FRAMEWORK Security)
+endif ()
+
+corrosion_import_crate(MANIFEST_PATH vortex/Cargo.toml
+#    CORROSION_TOOLS_RUST_TOOLCHAIN "nightly-2025-02-24"
+    CRATES vortex-ffi
+    FEATURES duckdb
+    IMPORTED_CRATES vortex_ffi
+)
 
 set(EXTENSION_NAME ${TARGET_NAME}_extension)
+set(EXTENSION_SOURCES src/vortex_extension.cpp src/expr/expr.cpp src/vortex_write.cpp src/vortex_scan.cpp)
 set(LOADABLE_EXTENSION_NAME ${TARGET_NAME}_loadable_extension)
 
-project(${TARGET_NAME})
-include_directories(src/include)
+# Generate C++ code from .proto files.
+file(GLOB PROTO_FILES "vortex/vortex-proto/proto/*.proto")
+set(PROTO_GEN_DIR ${CMAKE_CURRENT_SOURCE_DIR}/gen)
+file(MAKE_DIRECTORY ${PROTO_GEN_DIR})
+protobuf_generate_cpp(PROTO_SRCS PROTO_HDRS ${PROTO_FILES} PROTOC_OUT_DIR ${PROTO_GEN_DIR})
+
+include_directories(src/include ${PROTO_GEN_DIR} vortex/vortex-ffi/cinclude)
 
-set(EXTENSION_SOURCES src/quack_extension.cpp)
+build_static_extension(${TARGET_NAME} ${EXTENSION_SOURCES} ${PROTO_SRCS})
+build_loadable_extension(${TARGET_NAME} ${EXTENSION_SOURCES} ${PROTO_SRCS})
 
-build_static_extension(${TARGET_NAME} ${EXTENSION_SOURCES})
-build_loadable_extension(${TARGET_NAME} " " ${EXTENSION_SOURCES})
+target_link_libraries(${EXTENSION_NAME}
+    vortex_ffi-static
+    protobuf::libprotobuf
+    ${CORE_FOUNDATION_FRAMEWORK}
+    ${SECURITY_FRAMEWORK}
+)
+target_link_libraries(${LOADABLE_EXTENSION_NAME}
+    vortex_ffi-shared
+    protobuf::libprotobuf
+    ${CORE_FOUNDATION_FRAMEWORK}
+    ${SECURITY_FRAMEWORK}
+)
 
-# Link OpenSSL in both the static library as the loadable extension
-target_link_libraries(${EXTENSION_NAME} OpenSSL::SSL OpenSSL::Crypto)
-target_link_libraries(${LOADABLE_EXTENSION_NAME} OpenSSL::SSL OpenSSL::Crypto)
+add_subdirectory(test)
 
 install(
-  TARGETS ${EXTENSION_NAME}
-  EXPORT "${DUCKDB_EXPORT_SET}"
-  LIBRARY DESTINATION "${INSTALL_LIB_DIR}"
-  ARCHIVE DESTINATION "${INSTALL_LIB_DIR}")
+    TARGETS ${EXTENSION_NAME}
+    EXPORT "${DUCKDB_EXPORT_SET}"
+    LIBRARY DESTINATION "${INSTALL_LIB_DIR}"
+    ARCHIVE DESTINATION "${INSTALL_LIB_DIR}"
+)

Makefile

@@ -1,8 +1,14 @@
 PROJ_DIR := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
 
 # Configuration of extension
-EXT_NAME=quack
+EXT_NAME=vortex_duckdb
 EXT_CONFIG=${PROJ_DIR}extension_config.cmake
+EXT_FLAGS=-DDISABLE_VPTR_SANITIZER=ON -DOVERRIDE_GIT_DESCRIBE=v1.2.2
+EXT_FLAGS += -DCMAKE_OSX_DEPLOYMENT_TARGET=13.0
+
+export MACOSX_DEPLOYMENT_TARGET=13.0
+export VCPKG_OSX_DEPLOYMENT_TARGET=13.0
+export VCPKG_FEATURE_FLAGS=-binarycaching
 
 # Include the Makefile from extension-ci-tools
-include extension-ci-tools/makefiles/duckdb_extension.Makefile
+include extension-ci-tools/makefiles/duckdb_extension.Makefile

docs/NEXT_README.md README.mddocs/NEXT_README.md renamed to README.md

@@ -1,86 +1,124 @@
-# Quack
+# VortexDuckdb
 
-This repository is based on https://github.com/duckdb/extension-template, check it out if you want to build and ship your own DuckDB extension.
+This repository is based on https://github.com/duckdb/extension-template, check it out if you want to build and ship
+your own DuckDB extension.
 
 ---
 
-This extension, Quack, allow you to ... <extension_goal>.
-
+This extension, VortexDuckdb, allow you to ... <extension_goal>.
 
 ## Building
+
+### Install required system dependencies
+
+#### MacOS
+
+```shell
+brew install pkg-config
+```
+
 ### Managing dependencies
-DuckDB extensions uses VCPKG for dependency management. Enabling VCPKG is very simple: follow the [installation instructions](https://vcpkg.io/en/getting-started) or just run the following:
+
+DuckDB extensions uses VCPKG for dependency management. Enabling VCPKG is very simple: follow
+the [installation instructions](https://vcpkg.io/en/getting-started) or just run the following:
+
 ```shell
 git clone https://github.com/Microsoft/vcpkg.git
 ./vcpkg/bootstrap-vcpkg.sh
 export VCPKG_TOOLCHAIN_PATH=`pwd`/vcpkg/scripts/buildsystems/vcpkg.cmake
 ```
-Note: VCPKG is only required for extensions that want to rely on it for dependency management. If you want to develop an extension without dependencies, or want to do your own dependency management, just skip this step. Note that the example extension uses VCPKG to build with a dependency for instructive purposes, so when skipping this step the build may not work without removing the dependency.
+
+Note: VCPKG is only required for extensions that want to rely on it for dependency management. If you want to develop an
+extension without dependencies, or want to do your own dependency management, just skip this step. Note that the example
+extension uses VCPKG to build with a dependency for instructive purposes, so when skipping this step the build may not
+work without removing the dependency.
 
 ### Build steps
+
 Now to build the extension, run:
+
 ```sh
 make
 ```
+
 The main binaries that will be built are:
+
 ```sh
 ./build/release/duckdb
 ./build/release/test/unittest
-./build/release/extension/quack/quack.duckdb_extension
+./build/release/extension/vortex_duckdb/vortex_duckdb.duckdb_extension
 ```
+
 - `duckdb` is the binary for the duckdb shell with the extension code automatically loaded.
 - `unittest` is the test runner of duckdb. Again, the extension is already linked into the binary.
-- `quack.duckdb_extension` is the loadable binary as it would be distributed.
+- `vortex_duckdb.duckdb_extension` is the loadable binary as it would be distributed.
 
 ## Running the extension
+
 To run the extension code, simply start the shell with `./build/release/duckdb`.
 
-Now we can use the features from the extension directly in DuckDB. The template contains a single scalar function `quack()` that takes a string arguments and returns a string:
+Now we can use the features from the extension directly in DuckDB. The template contains a single scalar function
+`vortex_duckdb()` that takes a string arguments and returns a string:
+
 ```
-D select quack('Jane') as result;
+D select vortex_duckdb('Jane') as result;
 ┌───────────────┐
 │    result     │
 │    varchar    │
 ├───────────────┤
-│ Quack Jane 🐥 │
+│ VortexDuckdb Jane 🐥 │
 └───────────────┘
 ```
 
 ## Running the tests
-Different tests can be created for DuckDB extensions. The primary way of testing DuckDB extensions should be the SQL tests in `./test/sql`. These SQL tests can be run using:
+
+Different tests can be created for DuckDB extensions. The primary way of testing DuckDB extensions should be the SQL
+tests in `./test/sql`. These SQL tests can be run using:
+
 ```sh
 make test
 ```
 
 ### Installing the deployed binaries
+
 To install your extension binaries from S3, you will need to do two things. Firstly, DuckDB should be launched with the
 `allow_unsigned_extensions` option set to true. How to set this will depend on the client you're using. Some examples:
 
 CLI:
+
 ```shell
 duckdb -unsigned
 ```
 
 Python:
+
 ```python
-con = duckdb.connect(':memory:', config={'allow_unsigned_extensions' : 'true'})
+con = duckdb.connect(':memory:', config={'allow_unsigned_extensions': 'true'})
 ```
 
 NodeJS:
+
 ```js
 db = new duckdb.Database(':memory:', {"allow_unsigned_extensions": "true"});
 ```
 
-Secondly, you will need to set the repository endpoint in DuckDB to the HTTP url of your bucket + version of the extension
+Secondly, you will need to set the repository endpoint in DuckDB to the HTTP url of your bucket + version of the
+extension
 you want to install. To do this run the following SQL query in DuckDB:
+
 ```sql
-SET custom_extension_repository='bucket.s3.eu-west-1.amazonaws.com/<your_extension_name>/latest';
+SET
+custom_extension_repository='bucket.s3.eu-west-1.amazonaws.com/<your_extension_name>/latest';
 ```
-Note that the `/latest` path will allow you to install the latest extension version available for your current version of
+
+Note that the `/latest` path will allow you to install the latest extension version available for your current version
+of
 DuckDB. To specify a specific version, you can pass the version instead.
 
 After running these steps, you can install and load your extension using the regular INSTALL/LOAD commands in DuckDB:
+
 ```sql
-INSTALL quack
-LOAD quack
+INSTALL
+vortex_duckdb
+LOAD vortex_duckdb
 ```