diff --git a/.github/workflows/ExtensionTemplate.yml b/.github/workflows/ExtensionTemplate.yml deleted file mode 100644 index 0b2c52c..0000000 --- a/.github/workflows/ExtensionTemplate.yml +++ /dev/null @@ -1,178 +0,0 @@ -# -# NOTE: this workflow is for testing the extension template itself, -# this workflow will be removed when scripts/bootstrap-template.py is run -# -name: Extension Template -on: [push, pull_request,repository_dispatch] -concurrency: - group: ${{ github.workflow }}-${{ github.ref }}-${{ github.head_ref || '' }}-${{ github.base_ref || '' }}-${{ github.ref != 'refs/heads/main' || github.sha }} - cancel-in-progress: true - -jobs: - linux: - name: Linux - if: ${{ vars.RUN_RENAME_TEST == 'true' || github.repository == 'duckdb/extension-template' }} - runs-on: ubuntu-latest - container: ubuntu:18.04 - strategy: - matrix: - # Add commits/tags to build against other DuckDB versions - duckdb_version: [ '' ] - env: - VCPKG_TOOLCHAIN_PATH: ${{ github.workspace }}/vcpkg/scripts/buildsystems/vcpkg.cmake - VCPKG_TARGET_TRIPLET: 'x64-linux' - GEN: ninja - ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION: true - defaults: - run: - shell: bash - - steps: - - name: Install required ubuntu packages - run: | - apt-get update -y -qq - apt-get install -y -qq software-properties-common - add-apt-repository ppa:git-core/ppa - apt-get update -y -qq - apt-get install -y -qq ninja-build make gcc-multilib g++-multilib libssl-dev wget openjdk-8-jdk zip maven unixodbc-dev libc6-dev-i386 lib32readline6-dev libssl-dev libcurl4-gnutls-dev libexpat1-dev gettext unzip build-essential checkinstall libffi-dev curl libz-dev openssh-client - - - name: Install Git 2.18.5 - run: | - wget https://github.com/git/git/archive/refs/tags/v2.18.5.tar.gz - tar xvf v2.18.5.tar.gz - cd git-2.18.5 - make - make prefix=/usr install - git --version - - - uses: actions/checkout@v3 - with: - fetch-depth: 0 - submodules: 'true' - - - name: Checkout DuckDB to version - if: ${{ matrix.duckdb_version != ''}} - run: | - cd duckdb - git checkout ${{ matrix.duckdb_version }} - - - uses: ./duckdb/.github/actions/ubuntu_18_setup - - - name: Setup vcpkg - uses: lukka/run-vcpkg@v11.1 - with: - vcpkgGitCommitId: a1a1cbc975abf909a6c8985a6a2b8fe20bbd9bd6 - - - name: Rename extension - run: | - python3 scripts/bootstrap-template.py ext_1_a_123b_b11 - - - name: Build - run: | - make - - - name: Test - run: | - make test - - macos: - name: MacOS - if: ${{ vars.RUN_RENAME_TEST == 'true' || github.repository == 'duckdb/extension-template' }} - runs-on: macos-latest - strategy: - matrix: - # Add commits/tags to build against other DuckDB versions - duckdb_version: [ ''] - env: - VCPKG_TOOLCHAIN_PATH: ${{ github.workspace }}/vcpkg/scripts/buildsystems/vcpkg.cmake - VCPKG_TARGET_TRIPLET: 'x64-osx' - OSX_BUILD_ARCH: 'x86_64' - GEN: ninja - defaults: - run: - shell: bash - - steps: - - uses: actions/checkout@v3 - with: - fetch-depth: 0 - submodules: 'true' - - - name: Install Ninja - run: brew install ninja - - - uses: actions/setup-python@v2 - with: - python-version: '3.11' - - - name: Checkout DuckDB to version - if: ${{ matrix.duckdb_version != ''}} - run: | - cd duckdb - git checkout ${{ matrix.duckdb_version }} - - - name: Setup vcpkg - uses: lukka/run-vcpkg@v11.1 - with: - vcpkgGitCommitId: a1a1cbc975abf909a6c8985a6a2b8fe20bbd9bd6 - - - name: Rename extension - run: | - python scripts/bootstrap-template.py ext_1_a_123b_b11 - - - name: Build - run: | - make - - - name: Test - run: | - make test - - windows: - name: Windows - if: ${{ vars.RUN_RENAME_TEST == 'true' || github.repository == 'duckdb/extension-template' }} - runs-on: windows-latest - strategy: - matrix: - # Add commits/tags to build against other DuckDB versions - duckdb_version: [ '' ] - env: - VCPKG_TOOLCHAIN_PATH: ${{ github.workspace }}/vcpkg/scripts/buildsystems/vcpkg.cmake - VCPKG_TARGET_TRIPLET: 'x64-windows-static-md' - defaults: - run: - shell: bash - - steps: - - uses: actions/checkout@v3 - with: - fetch-depth: 0 - submodules: 'true' - - - uses: actions/setup-python@v2 - with: - python-version: '3.11' - - - name: Checkout DuckDB to version - # Add commits/tags to build against other DuckDB versions - if: ${{ matrix.duckdb_version != ''}} - run: | - cd duckdb - git checkout ${{ matrix.duckdb_version }} - - - name: Setup vcpkg - uses: lukka/run-vcpkg@v11.1 - with: - vcpkgGitCommitId: a1a1cbc975abf909a6c8985a6a2b8fe20bbd9bd6 - - - name: Rename extension - run: | - python scripts/bootstrap-template.py ext_1_a_123b_b11 - - - name: Build - run: | - make - - - name: Test extension - run: | - build/release/test/Release/unittest.exe \ No newline at end of file diff --git a/.github/workflows/MainDistributionPipeline.yml b/.github/workflows/MainDistributionPipeline.yml index 0b96e22..b7f0b26 100644 --- a/.github/workflows/MainDistributionPipeline.yml +++ b/.github/workflows/MainDistributionPipeline.yml @@ -18,7 +18,7 @@ jobs: with: duckdb_version: main ci_tools_version: main - extension_name: quack + extension_name: wvlet duckdb-stable-build: name: Build extension binaries @@ -26,7 +26,7 @@ jobs: with: duckdb_version: v1.1.3 ci_tools_version: v1.1.3 - extension_name: quack + extension_name: wvlet duckdb-stable-deploy: name: Deploy extension binaries @@ -35,5 +35,5 @@ jobs: secrets: inherit with: duckdb_version: v1.1.3 - extension_name: quack + extension_name: wvlet deploy_latest: ${{ startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main' }} diff --git a/CMakeLists.txt b/CMakeLists.txt index 1d144aa..723cfe4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,27 +1,51 @@ cmake_minimum_required(VERSION 3.5) # Set extension name here -set(TARGET_NAME quack) +set(TARGET_NAME wvlet) # 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) +# Define wvlet library details +set(WVLET_LIB_URL "https://github.com/quackmagic/wvlet-lib/releases/download/v2024.9.12/libwvlet_linux-x64.so") +set(WVLET_LIB_PATH "${CMAKE_CURRENT_SOURCE_DIR}/third-party/libwvlet_linux-x64.so") + +# Download wvlet library if it doesn't exist +if(NOT EXISTS ${WVLET_LIB_PATH}) + message(STATUS "Downloading wvlet library from ${WVLET_LIB_URL}") + # Create third-party directory if it doesn't exist + file(MAKE_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/third-party") + # Download the file + file(DOWNLOAD + ${WVLET_LIB_URL} + ${WVLET_LIB_PATH} + SHOW_PROGRESS + STATUS DOWNLOAD_STATUS + TLS_VERIFY ON) + + list(GET DOWNLOAD_STATUS 0 STATUS_CODE) + if(NOT STATUS_CODE EQUAL 0) + message(FATAL_ERROR "Failed to download wvlet library") + endif() + +endif() + set(EXTENSION_NAME ${TARGET_NAME}_extension) set(LOADABLE_EXTENSION_NAME ${TARGET_NAME}_loadable_extension) project(${TARGET_NAME}) include_directories(src/include) -set(EXTENSION_SOURCES src/quack_extension.cpp) +set(EXTENSION_SOURCES src/wvlet_extension.cpp) build_static_extension(${TARGET_NAME} ${EXTENSION_SOURCES}) build_loadable_extension(${TARGET_NAME} " " ${EXTENSION_SOURCES}) # 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) +target_link_libraries(${EXTENSION_NAME} OpenSSL::SSL OpenSSL::Crypto ${WVLET_LIB_PATH}) +target_link_libraries(${LOADABLE_EXTENSION_NAME} OpenSSL::SSL OpenSSL::Crypto ${WVLET_LIB_PATH}) install( TARGETS ${EXTENSION_NAME} diff --git a/Makefile b/Makefile index e91db43..c461402 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ PROJ_DIR := $(dir $(abspath $(lastword $(MAKEFILE_LIST)))) # Configuration of extension -EXT_NAME=quack +EXT_NAME=wvlet EXT_CONFIG=${PROJ_DIR}extension_config.cmake # Include the Makefile from extension-ci-tools diff --git a/docs/NEXT_README.md b/docs/NEXT_README.md deleted file mode 100644 index 96f0482..0000000 --- a/docs/NEXT_README.md +++ /dev/null @@ -1,86 +0,0 @@ -# Quack - -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 ... . - - -## Building -### 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: -```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. - -### 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 -``` -- `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. - -## 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: -``` -D select quack('Jane') as result; -┌───────────────┐ -│ result │ -│ varchar │ -├───────────────┤ -│ Quack 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: -```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'}) -``` - -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 -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//latest'; -``` -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 -``` diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 7825350..0000000 --- a/docs/README.md +++ /dev/null @@ -1,137 +0,0 @@ -# DuckDB Extension Template -This repository contains a template for creating a DuckDB extension. The main goal of this template is to allow users to easily develop, test and distribute their own DuckDB extension. The main branch of the template is always based on the latest stable DuckDB allowing you to try out your extension right away. - -## Getting started -First step to getting started is to create your own repo from this template by clicking `Use this template`. Then clone your new repository using -```sh -git clone --recurse-submodules https://github.com//.git -``` -Note that `--recurse-submodules` will ensure DuckDB is pulled which is required to build the extension. - -## Building -### 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: -```shell -cd -git clone https://github.com/Microsoft/vcpkg.git -sh ./vcpkg/scripts/bootstrap.sh -disableMetrics -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. - -### 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//.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. -- `.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`. This shell will have the extension pre-loaded. - -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: -``` -D select quack('Jane') as result; -┌───────────────┐ -│ result │ -│ varchar │ -├───────────────┤ -│ Quack 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: -```sh -make test -``` - -## Getting started with your own extension -After creating a repository from this template, the first step is to name your extension. To rename the extension, run: -``` -python3 ./scripts/bootstrap-template.py -``` -Feel free to delete the script after this step. - -Now you're good to go! After a (re)build, you should now be able to use your duckdb extension: -``` -./build/release/duckdb -D select ('Jane') as result; -┌─────────────────────────────────────┐ -│ result │ -│ varchar │ -├─────────────────────────────────────┤ -│ Jane 🐥 │ -└─────────────────────────────────────┘ -``` - -For inspiration/examples on how to extend DuckDB in a more meaningful way, check out the [test extensions](https://github.com/duckdb/duckdb/blob/main/test/extension), -the [in-tree extensions](https://github.com/duckdb/duckdb/tree/main/extension), and the [out-of-tree extensions](https://github.com/duckdblabs). - -## Distributing your extension -Easy distribution of extensions built with this template is facilitated using a similar process used by DuckDB itself. -Binaries are generated for various versions/platforms allowing duckdb to automatically install the correct binary. - -This step requires that you pass the following 4 parameters to your GitHub repo as action secrets: - -| secret name | description | -| ------------- | ----------------------------------- | -| S3_REGION | s3 region holding your bucket | -| S3_BUCKET | the name of the bucket to deploy to | -| S3_DEPLOY_ID | the S3 key id | -| S3_DEPLOY_KEY | the S3 key secret | - -After setting these variables, all pushes to main will trigger a new (dev) release. Note that your AWS token should -have full permissions to the bucket, and you will need to have ACLs enabled. - -### 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 -``` - -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//latest'; -``` -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 -LOAD -``` - -### Versioning of your extension -Extension binaries will only work for the specific DuckDB version they were built for. The version of DuckDB that is targeted -is set to the latest stable release for the main branch of the template so initially that is all you need. As new releases -of DuckDB are published however, the extension repository will need to be updated. The template comes with a workflow set-up -that will automatically build the binaries for all DuckDB target architectures that are available in the corresponding DuckDB -version. This workflow is found in `.github/workflows/MainDistributionPipeline.yml`. It is up to the extension developer to keep -this up to date with DuckDB. Note also that its possible to distribute binaries for multiple DuckDB versions in this workflow -by simply duplicating the jobs. - -## Setting up CLion - -### Opening project -Configuring CLion with the extension template requires a little work. Firstly, make sure that the DuckDB submodule is available. -Then make sure to open `./duckdb/CMakeLists.txt` (so not the top level `CMakeLists.txt` file from this repo) as a project in CLion. -Now to fix your project path go to `tools->CMake->Change Project Root`([docs](https://www.jetbrains.com/help/clion/change-project-root-directory.html)) to set the project root to the root dir of this repo. - -### Debugging -To set up debugging in CLion, there are two simple steps required. Firstly, in `CLion -> Settings / Preferences -> Build, Execution, Deploy -> CMake` you will need to add the desired builds (e.g. Debug, Release, RelDebug, etc). There's different ways to configure this, but the easiest is to leave all empty, except the `build path`, which needs to be set to `../build/{build type}`. Now on a clean repository you will first need to run `make {build type}` to initialize the CMake build directory. After running make, you will be able to (re)build from CLion by using the build target we just created. If you use the CLion editor, you can create a CLion CMake profiles matching the CMake variables that are described in the makefile, and then you don't need to invoke the Makefile. - -The second step is to configure the unittest runner as a run/debug configuration. To do this, go to `Run -> Edit Configurations` and click `+ -> Cmake Application`. The target and executable should be `unittest`. This will run all the DuckDB tests. To specify only running the extension specific tests, add `--test-dir ../../.. [sql]` to the `Program Arguments`. Note that it is recommended to use the `unittest` executable for testing/development within CLion. The actual DuckDB CLI currently does not reliably work as a run target in CLion. diff --git a/extension_config.cmake b/extension_config.cmake index 959e702..5ba4a8f 100644 --- a/extension_config.cmake +++ b/extension_config.cmake @@ -1,7 +1,7 @@ # This file is included by DuckDB's build system. It specifies which extension to load # Extension from this repo -duckdb_extension_load(quack +duckdb_extension_load(wvlet SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR} LOAD_TESTS ) diff --git a/scripts/bootstrap-template.py b/scripts/bootstrap-template.py deleted file mode 100755 index 8f78fec..0000000 --- a/scripts/bootstrap-template.py +++ /dev/null @@ -1,94 +0,0 @@ -#!/usr/bin/python3 - -import sys, os, shutil, re -from pathlib import Path - - -def is_snake_case(s): - # Define the regex pattern for snake case with numbers - pattern = r"^[a-z0-9]+(_[a-z0-9]+)*$" - - # Use re.match to check if the string matches the pattern - if re.match(pattern, s): - return True - else: - return False - - -def to_camel_case(snake_str): - return "".join(x.capitalize() for x in snake_str.lower().split("_")) - - -def replace(file_name, to_find, to_replace): - with open(file_name, "r", encoding="utf8") as file: - filedata = file.read() - filedata = filedata.replace(to_find, to_replace) - with open(file_name, "w", encoding="utf8") as file: - file.write(filedata) - - -def replace_everywhere(to_find, to_replace): - for path in files_to_search: - replace(path, to_find, to_replace) - replace(path, to_find.capitalize(), to_camel_case(to_replace)) - replace(path, to_find.upper(), to_replace.upper()) - - replace("./CMakeLists.txt", to_find, to_replace) - replace("./Makefile", to_find, to_replace) - replace("./Makefile", to_find.capitalize(), to_camel_case(to_replace)) - replace("./Makefile", to_find.upper(), to_replace.upper()) - replace("./README.md", to_find, to_replace) - replace("./extension_config.cmake", to_find, to_replace) - replace("./scripts/setup-custom-toolchain.sh", to_find, to_replace) - - -if __name__ == "__main__": - if len(sys.argv) != 2: - raise Exception( - "usage: python3 bootstrap-template.py " - ) - - name_extension = sys.argv[1] - - if name_extension[0].isdigit(): - raise Exception("Please dont start your extension name with a number.") - - if not is_snake_case(name_extension): - raise Exception( - "Please enter the name of your extension in valid snake_case containing only lower case letters and numbers" - ) - - shutil.copyfile("docs/NEXT_README.md", "README.md") - os.remove("docs/NEXT_README.md") - os.remove("docs/README.md") - - files_to_search = [] - files_to_search.extend(Path("./.github").rglob("./**/*.yml")) - files_to_search.extend(Path("./test").rglob("./**/*.test")) - files_to_search.extend(Path("./src").rglob("./**/*.hpp")) - files_to_search.extend(Path("./src").rglob("./**/*.cpp")) - files_to_search.extend(Path("./src").rglob("./**/*.txt")) - files_to_search.extend(Path("./src").rglob("./*.md")) - - replace_everywhere("quack", name_extension) - replace_everywhere("Quack", name_extension.capitalize()) - replace_everywhere("", name_extension) - - string_to_replace = name_extension - string_to_find = "quack" - - # rename files - os.rename(f"test/sql/{string_to_find}.test", f"test/sql/{string_to_replace}.test") - os.rename( - f"src/{string_to_find}_extension.cpp", f"src/{string_to_replace}_extension.cpp" - ) - os.rename( - f"src/include/{string_to_find}_extension.hpp", - f"src/include/{string_to_replace}_extension.hpp", - ) - - # remove template-specific files - os.remove(".github/workflows/ExtensionTemplate.yml") - - # finally, remove this bootstrap file - os.remove(__file__) diff --git a/scripts/setup-custom-toolchain.sh b/scripts/setup-custom-toolchain.sh index 4a846fc..3ea12e3 100644 --- a/scripts/setup-custom-toolchain.sh +++ b/scripts/setup-custom-toolchain.sh @@ -7,5 +7,5 @@ # `.github/workflows/_extension_distribution.yml` from `https://github.com/duckdb/extension-ci-tools` # note that the $DUCKDB_PLATFORM environment variable can be used to discern between the platforms -echo "This is the sample custom toolchain script running for architecture '$DUCKDB_PLATFORM' for the quack extension." +echo "This is the sample custom toolchain script running for architecture '$DUCKDB_PLATFORM' for the wvlet extension." diff --git a/src/include/quack_extension.hpp b/src/include/quack_extension.hpp deleted file mode 100644 index 494467b..0000000 --- a/src/include/quack_extension.hpp +++ /dev/null @@ -1,14 +0,0 @@ -#pragma once - -#include "duckdb.hpp" - -namespace duckdb { - -class QuackExtension : public Extension { -public: - void Load(DuckDB &db) override; - std::string Name() override; - std::string Version() const override; -}; - -} // namespace duckdb diff --git a/src/include/wvlet_extension.hpp b/src/include/wvlet_extension.hpp new file mode 100644 index 0000000..fe5c095 --- /dev/null +++ b/src/include/wvlet_extension.hpp @@ -0,0 +1,21 @@ +#pragma once + +#include "duckdb.hpp" +#include "duckdb/function/scalar_function.hpp" + +namespace duckdb { + +class WvletExtension : public Extension { +public: + void Load(DuckDB &db) override; + std::string Name() override; + std::string Version() const override; +}; + +struct WvletScriptFunction { + static void ParseWvletScript(DataChunk &args, ExpressionState &state, Vector &result); + static unique_ptr Bind(ClientContext &context, ScalarFunction &bound_function, + vector> &arguments); +}; + +} // namespace duckdb diff --git a/src/quack_extension.cpp b/src/quack_extension.cpp deleted file mode 100644 index 468b2e2..0000000 --- a/src/quack_extension.cpp +++ /dev/null @@ -1,78 +0,0 @@ -#define DUCKDB_EXTENSION_MAIN - -#include "quack_extension.hpp" -#include "duckdb.hpp" -#include "duckdb/common/exception.hpp" -#include "duckdb/common/string_util.hpp" -#include "duckdb/function/scalar_function.hpp" -#include "duckdb/main/extension_util.hpp" -#include - -// OpenSSL linked through vcpkg -#include - -namespace duckdb { - -inline void QuackScalarFun(DataChunk &args, ExpressionState &state, Vector &result) { - auto &name_vector = args.data[0]; - UnaryExecutor::Execute( - name_vector, result, args.size(), - [&](string_t name) { - return StringVector::AddString(result, "Quack "+name.GetString()+" 🐥");; - }); -} - -inline void QuackOpenSSLVersionScalarFun(DataChunk &args, ExpressionState &state, Vector &result) { - auto &name_vector = args.data[0]; - UnaryExecutor::Execute( - name_vector, result, args.size(), - [&](string_t name) { - return StringVector::AddString(result, "Quack " + name.GetString() + - ", my linked OpenSSL version is " + - OPENSSL_VERSION_TEXT );; - }); -} - -static void LoadInternal(DatabaseInstance &instance) { - // Register a scalar function - auto quack_scalar_function = ScalarFunction("quack", {LogicalType::VARCHAR}, LogicalType::VARCHAR, QuackScalarFun); - ExtensionUtil::RegisterFunction(instance, quack_scalar_function); - - // Register another scalar function - auto quack_openssl_version_scalar_function = ScalarFunction("quack_openssl_version", {LogicalType::VARCHAR}, - LogicalType::VARCHAR, QuackOpenSSLVersionScalarFun); - ExtensionUtil::RegisterFunction(instance, quack_openssl_version_scalar_function); -} - -void QuackExtension::Load(DuckDB &db) { - LoadInternal(*db.instance); -} -std::string QuackExtension::Name() { - return "quack"; -} - -std::string QuackExtension::Version() const { -#ifdef EXT_VERSION_QUACK - return EXT_VERSION_QUACK; -#else - return ""; -#endif -} - -} // namespace duckdb - -extern "C" { - -DUCKDB_EXTENSION_API void quack_init(duckdb::DatabaseInstance &db) { - duckdb::DuckDB db_wrapper(db); - db_wrapper.LoadExtension(); -} - -DUCKDB_EXTENSION_API const char *quack_version() { - return duckdb::DuckDB::LibraryVersion(); -} -} - -#ifndef DUCKDB_EXTENSION_MAIN -#error DUCKDB_EXTENSION_MAIN not defined -#endif diff --git a/src/wvlet_extension.cpp b/src/wvlet_extension.cpp new file mode 100644 index 0000000..b22f4ae --- /dev/null +++ b/src/wvlet_extension.cpp @@ -0,0 +1,117 @@ +#define DUCKDB_EXTENSION_MAIN +#include "wvlet_extension.hpp" +#include "duckdb.hpp" +#include "duckdb/common/exception.hpp" +#include "duckdb/common/string_util.hpp" +#include "duckdb/function/table_function.hpp" +#include "duckdb/main/extension_util.hpp" +#include +#include +#include + +#include +#include +#include + +// OpenSSL linked through vcpkg +#include + +namespace duckdb { + +extern "C" { + int wvlet_compile_main(const char*); +} + +struct WvletBindData : public TableFunctionData { + string query; + bool has_returned = false; +}; + +static unique_ptr WvletBind(ClientContext &context, TableFunctionBindInput &input, + vector &return_types, vector &names) { + // Get all the lineitem columns here + auto result = make_uniq(); + result->query = input.inputs[0].GetValue(); + + // TODO: We should probably get these from the schema of the target table + return_types = {LogicalType::INTEGER, LogicalType::VARCHAR}; // Example columns + names = {"id", "name"}; // Example column names + + return std::move(result); +} + +static void WvletFunction(ClientContext &context, TableFunctionInput &data_p, DataChunk &output) { + auto &bind_data = (WvletBindData &)*data_p.bind_data; + + if (bind_data.has_returned) { + output.SetCardinality(0); + return; + } + + std::ostringstream captured_output; + FILE* original_stdout = stdout; + stdout = fdopen(fileno(stdout), "w"); + std::ostringstream captured_error; + FILE* original_stderr = stderr; + stderr = fdopen(fileno(stderr), "w"); + + // Convert script to JSON array format as expected by wvlet_compile_main + std::string json = "[\"-x\", \"-q\", \"" + bind_data.query + "\"]"; + + // Call wvlet compiler - it will print the SQL + int compile_result = wvlet_compile_main(json.c_str()); + + if (compile_result != 0) { + throw std::runtime_error("Failed to compile wvlet script"); + } + + std::string query = captured_output.str(); + std::cout << "Captured Output: " << query << std::endl; + + stdout = original_stdout; + stderr = original_stderr; + + // The SQL has been printed, now we can execute it + // TODO: Execute the printed SQL and fill the output chunk with results + + bind_data.has_returned = true; +} + +static void LoadInternal(DatabaseInstance &instance) { + TableFunction wvlet_func("wvlet", {LogicalType::VARCHAR}, + WvletFunction, WvletBind); + ExtensionUtil::RegisterFunction(instance, wvlet_func); +} + +void WvletExtension::Load(DuckDB &db) { + LoadInternal(*db.instance); +} + +std::string WvletExtension::Name() { + return "wvlet"; +} + +std::string WvletExtension::Version() const { +#ifdef EXT_VERSION_WVLET + return EXT_VERSION_WVLET; +#else + return ""; +#endif +} + +} // namespace duckdb + +extern "C" { +DUCKDB_EXTENSION_API void wvlet_init(duckdb::DatabaseInstance &db) { + duckdb::DuckDB db_wrapper(db); + db_wrapper.LoadExtension(); +} + +DUCKDB_EXTENSION_API const char *wvlet_version() { + return duckdb::DuckDB::LibraryVersion(); +} +} + +#ifndef DUCKDB_EXTENSION_MAIN +#error DUCKDB_EXTENSION_MAIN not defined +#endif diff --git a/test/sql/quack.test b/test/sql/quack.test deleted file mode 100644 index 519a354..0000000 --- a/test/sql/quack.test +++ /dev/null @@ -1,23 +0,0 @@ -# name: test/sql/quack.test -# description: test quack extension -# group: [quack] - -# Before we load the extension, this will fail -statement error -SELECT quack('Sam'); ----- -Catalog Error: Scalar Function with name quack does not exist! - -# Require statement will ensure this test is run with this extension loaded -require quack - -# Confirm the extension works -query I -SELECT quack('Sam'); ----- -Quack Sam 🐥 - -query I -SELECT quack_openssl_version('Michael') ILIKE 'Quack Michael, my linked OpenSSL version is OpenSSL%'; ----- -true