From 93378263e219f7f9626c2d1a438649674ab73a59 Mon Sep 17 00:00:00 2001 From: Joe Isaacs Date: Thu, 6 Mar 2025 12:04:38 +0000 Subject: [PATCH 01/12] add module --- .gitmodules | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .gitmodules diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000000..da52057df0 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,8 @@ +[submodule "duckdb"] + path = vortex-duckdb/duckdb + url = https://github.com/duckdb/duckdb + branch = main +[submodule "extension-ci-tools"] + path = vortex-duckdb/extension-ci-tools + url = https://github.com/duckdb/extension-ci-tools + branch = main \ No newline at end of file From fb3ab5963fb5af2f8f1fe5533bf2fa21a779efe7 Mon Sep 17 00:00:00 2001 From: Joe Isaacs Date: Thu, 6 Mar 2025 12:10:12 +0000 Subject: [PATCH 02/12] update --- .gitmodules | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.gitmodules b/.gitmodules index da52057df0..83344f6a93 100644 --- a/.gitmodules +++ b/.gitmodules @@ -5,4 +5,10 @@ [submodule "extension-ci-tools"] path = vortex-duckdb/extension-ci-tools url = https://github.com/duckdb/extension-ci-tools - branch = main \ No newline at end of file + branch = main +[submodule "duckdb"] + path = vortex-duckdb/duckdb + url = https://github.com/duckdb/duckdb +[submodule "extension-ci-tools"] + path = vortex-duckdb/extension-ci-tools + url = https://github.com/duckdb/extension-ci-tools From 91dac65a409550294b71a627fae57632d209ebce Mon Sep 17 00:00:00 2001 From: Joe Isaacs Date: Thu, 6 Mar 2025 12:14:51 +0000 Subject: [PATCH 03/12] add duckdb --- vortex-duckdb/.clang-format | 1 + vortex-duckdb/.clang-tidy | 1 + vortex-duckdb/.editorconfig | 1 + .../.github/workflows/ExtensionTemplate.yml | 162 ++++++++++++++ .../workflows/MainDistributionPipeline.yml | 29 +++ vortex-duckdb/.gitignore | 8 + vortex-duckdb/LICENSE | 7 + vortex-duckdb/Makefile | 8 + vortex-duckdb/docs/NEXT_README.md | 86 ++++++++ vortex-duckdb/docs/README.md | 146 +++++++++++++ vortex-duckdb/docs/UPDATING.md | 23 ++ vortex-duckdb/duckdb | 1 + vortex-duckdb/extension-ci-tools | 1 + vortex-duckdb/extension_config.cmake | 10 + vortex-duckdb/scripts/bootstrap-template.py | 200 ++++++++++++++++++ vortex-duckdb/scripts/extension-upload.sh | 90 ++++++++ .../scripts/setup-custom-toolchain.sh | 11 + vortex-duckdb/src/include/quack_extension.hpp | 14 ++ vortex-duckdb/src/quack_extension.cpp | 78 +++++++ vortex-duckdb/test/README.md | 11 + vortex-duckdb/test/sql/quack.test | 23 ++ vortex-duckdb/vcpkg.json | 5 + 22 files changed, 916 insertions(+) create mode 120000 vortex-duckdb/.clang-format create mode 120000 vortex-duckdb/.clang-tidy create mode 120000 vortex-duckdb/.editorconfig create mode 100644 vortex-duckdb/.github/workflows/ExtensionTemplate.yml create mode 100644 vortex-duckdb/.github/workflows/MainDistributionPipeline.yml create mode 100644 vortex-duckdb/.gitignore create mode 100644 vortex-duckdb/LICENSE create mode 100644 vortex-duckdb/Makefile create mode 100644 vortex-duckdb/docs/NEXT_README.md create mode 100644 vortex-duckdb/docs/README.md create mode 100644 vortex-duckdb/docs/UPDATING.md create mode 160000 vortex-duckdb/duckdb create mode 160000 vortex-duckdb/extension-ci-tools create mode 100644 vortex-duckdb/extension_config.cmake create mode 100755 vortex-duckdb/scripts/bootstrap-template.py create mode 100755 vortex-duckdb/scripts/extension-upload.sh create mode 100644 vortex-duckdb/scripts/setup-custom-toolchain.sh create mode 100644 vortex-duckdb/src/include/quack_extension.hpp create mode 100644 vortex-duckdb/src/quack_extension.cpp create mode 100644 vortex-duckdb/test/README.md create mode 100644 vortex-duckdb/test/sql/quack.test create mode 100644 vortex-duckdb/vcpkg.json diff --git a/vortex-duckdb/.clang-format b/vortex-duckdb/.clang-format new file mode 120000 index 0000000000..9a13bb6331 --- /dev/null +++ b/vortex-duckdb/.clang-format @@ -0,0 +1 @@ +duckdb/.clang-format \ No newline at end of file diff --git a/vortex-duckdb/.clang-tidy b/vortex-duckdb/.clang-tidy new file mode 120000 index 0000000000..b438d44f6c --- /dev/null +++ b/vortex-duckdb/.clang-tidy @@ -0,0 +1 @@ +duckdb/.clang-tidy \ No newline at end of file diff --git a/vortex-duckdb/.editorconfig b/vortex-duckdb/.editorconfig new file mode 120000 index 0000000000..ec7786c1e5 --- /dev/null +++ b/vortex-duckdb/.editorconfig @@ -0,0 +1 @@ +duckdb/.editorconfig \ No newline at end of file diff --git a/vortex-duckdb/.github/workflows/ExtensionTemplate.yml b/vortex-duckdb/.github/workflows/ExtensionTemplate.yml new file mode 100644 index 0000000000..971253257e --- /dev/null +++ b/vortex-duckdb/.github/workflows/ExtensionTemplate.yml @@ -0,0 +1,162 @@ +# +# 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 + 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 Ninja + shell: bash + run: sudo apt-get update -y -qq && sudo apt-get install -y -qq ninja-build + + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + submodules: 'true' + + - 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: | + 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@v4 + 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@v4 + 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/vortex-duckdb/.github/workflows/MainDistributionPipeline.yml b/vortex-duckdb/.github/workflows/MainDistributionPipeline.yml new file mode 100644 index 0000000000..5fc278c18b --- /dev/null +++ b/vortex-duckdb/.github/workflows/MainDistributionPipeline.yml @@ -0,0 +1,29 @@ +# +# This workflow calls the main distribution pipeline from DuckDB to build, test and (optionally) release the extension +# +name: Main Extension Distribution Pipeline +on: + push: + pull_request: + workflow_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: + duckdb-next-build: + name: Build extension binaries + uses: duckdb/extension-ci-tools/.github/workflows/_extension_distribution.yml@main + with: + duckdb_version: main + ci_tools_version: main + extension_name: quack + + duckdb-stable-build: + name: Build extension binaries + uses: duckdb/extension-ci-tools/.github/workflows/_extension_distribution.yml@v1.2.0 + with: + duckdb_version: v1.2.0 + ci_tools_version: v1.2.0 + extension_name: quack \ No newline at end of file diff --git a/vortex-duckdb/.gitignore b/vortex-duckdb/.gitignore new file mode 100644 index 0000000000..b9f264b9aa --- /dev/null +++ b/vortex-duckdb/.gitignore @@ -0,0 +1,8 @@ +build +.idea +cmake-build-debug +duckdb_unittest_tempdir/ +.DS_Store +testext +test/python/__pycache__/ +.Rhistory diff --git a/vortex-duckdb/LICENSE b/vortex-duckdb/LICENSE new file mode 100644 index 0000000000..a14aed3120 --- /dev/null +++ b/vortex-duckdb/LICENSE @@ -0,0 +1,7 @@ +Copyright 2018-2025 Stichting DuckDB Foundation + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/vortex-duckdb/Makefile b/vortex-duckdb/Makefile new file mode 100644 index 0000000000..e91db43b69 --- /dev/null +++ b/vortex-duckdb/Makefile @@ -0,0 +1,8 @@ +PROJ_DIR := $(dir $(abspath $(lastword $(MAKEFILE_LIST)))) + +# Configuration of extension +EXT_NAME=quack +EXT_CONFIG=${PROJ_DIR}extension_config.cmake + +# Include the Makefile from extension-ci-tools +include extension-ci-tools/makefiles/duckdb_extension.Makefile \ No newline at end of file diff --git a/vortex-duckdb/docs/NEXT_README.md b/vortex-duckdb/docs/NEXT_README.md new file mode 100644 index 0000000000..96f0482a2a --- /dev/null +++ b/vortex-duckdb/docs/NEXT_README.md @@ -0,0 +1,86 @@ +# 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/vortex-duckdb/docs/README.md b/vortex-duckdb/docs/README.md new file mode 100644 index 0000000000..f057396919 --- /dev/null +++ b/vortex-duckdb/docs/README.md @@ -0,0 +1,146 @@ +# 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. + +### Tips for speedy builds +DuckDB extensions currently rely on DuckDB's build system to provide easy testing and distributing. This does however come at the downside of requiring the template to build DuckDB and its unittest binary every time you build your extension. To mitigate this, we highly recommend installing [ccache](https://ccache.dev/) and [ninja](https://ninja-build.org/). This will ensure you only need to build core DuckDB once and allows for rapid rebuilds. + +To build using ninja and ccache ensure both are installed and run: + +```sh +GEN=ninja make +``` + +## 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 +To distribute your extension binaries, there are a few options. + +### Community extensions +The recommended way of distributing extensions is through the [community extensions repository](https://github.com/duckdb/community-extensions). +This repository is designed specifically for extensions that are built using this extension template, meaning that as long as your extension can be +built using the default CI in this template, submitting it to the community extensions is a very simple process. The process works similarly to popular +package managers like homebrew and vcpkg, where a PR containing a descriptor file is submitted to the package manager repository. After the CI in the +community extensions repository completes, the extension can be installed and loaded in DuckDB with: +```SQL +INSTALL FROM community; +LOAD +``` +For more information, see the [community extensions documentation](https://duckdb.org/community_extensions/documentation). + +### Downloading artifacts from GitHub +The default CI in this template will automatically upload the binaries for every push to the main branch as GitHub Actions artifacts. These +can be downloaded manually and then loaded directly using: +```SQL +LOAD '/path/to/downloaded/extension.duckdb_extension'; +``` +Note that this will require starting DuckDB with the +`allow_unsigned_extensions` option set to true. How to set this will depend on the client you're using. For the CLI it is done like: +```shell +duckdb -unsigned +``` + +### Uploading to a custom repository +If for some reason distributing through community extensions is not an option, extensions can also be uploaded to a custom extension repository. +This will give some more control over where and how the extensions are distributed, but comes with the downside of requiring the `allow_unsigned_extensions` +option to be set. For examples of how to configure a manual GitHub Actions deploy pipeline, check out the extension deploy script in https://github.com/duckdb/extension-ci-tools. +Some examples of extensions that use this CI/CD workflow check out [spatial](https://github.com/duckdblabs/duckdb_spatial) or [aws](https://github.com/duckdb/duckdb_aws). + +Extensions in custom repositories can be installed and loaded using: +```SQL +INSTALL FROM 'http://my-custom-repo' +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/vortex-duckdb/docs/UPDATING.md b/vortex-duckdb/docs/UPDATING.md new file mode 100644 index 0000000000..a3ac73eff8 --- /dev/null +++ b/vortex-duckdb/docs/UPDATING.md @@ -0,0 +1,23 @@ +# Extension updating +When cloning this template, the target version of DuckDB should be the latest stable release of DuckDB. However, there +will inevitably come a time when a new DuckDB is released and the extension repository needs updating. This process goes +as follows: + +- Bump submodules + - `./duckdb` should be set to latest tagged release + - `./extension-ci-tools` should be set to updated branch corresponding to latest DuckDB release. So if you're building for DuckDB `v1.1.0` there will be a branch in `extension-ci-tools` named `v1.1.0` to which you should check out. +- Bump versions in `./github/workflows` + - `duckdb_version` input in `duckdb-stable-build` job in `MainDistributionPipeline.yml` should be set to latest tagged release + - `duckdb_version` input in `duckdb-stable-deploy` job in `MainDistributionPipeline.yml` should be set to latest tagged release + - the reusable workflow `duckdb/extension-ci-tools/.github/workflows/_extension_distribution.yml` for the `duckdb-stable-build` job should be set to latest tagged release + +# API changes +DuckDB extensions built with this extension template are built against the internal C++ API of DuckDB. This API is not guaranteed to be stable. +What this means for extension development is that when updating your extensions DuckDB target version using the above steps, you may run into the fact that your extension no longer builds properly. + +Currently, DuckDB does not (yet) provide a specific change log for these API changes, but it is generally not too hard to figure out what has changed. + +For figuring out how and why the C++ API changed, we recommend using the following resources: +- DuckDB's [Release Notes](https://github.com/duckdb/duckdb/releases) +- DuckDB's history of [Core extension patches](https://github.com/duckdb/duckdb/commits/main/.github/patches/extensions) +- The git history of the relevant C++ Header file of the API that has changed \ No newline at end of file diff --git a/vortex-duckdb/duckdb b/vortex-duckdb/duckdb new file mode 160000 index 0000000000..1df191691f --- /dev/null +++ b/vortex-duckdb/duckdb @@ -0,0 +1 @@ +Subproject commit 1df191691fb616dda6d3f5c5e350f0ca3d8e656b diff --git a/vortex-duckdb/extension-ci-tools b/vortex-duckdb/extension-ci-tools new file mode 160000 index 0000000000..9ca0be81af --- /dev/null +++ b/vortex-duckdb/extension-ci-tools @@ -0,0 +1 @@ +Subproject commit 9ca0be81af0c008e4561847633a80341e803258e diff --git a/vortex-duckdb/extension_config.cmake b/vortex-duckdb/extension_config.cmake new file mode 100644 index 0000000000..959e702d93 --- /dev/null +++ b/vortex-duckdb/extension_config.cmake @@ -0,0 +1,10 @@ +# This file is included by DuckDB's build system. It specifies which extension to load + +# Extension from this repo +duckdb_extension_load(quack + SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR} + LOAD_TESTS +) + +# Any extra extensions that should be built +# e.g.: duckdb_extension_load(json) \ No newline at end of file diff --git a/vortex-duckdb/scripts/bootstrap-template.py b/vortex-duckdb/scripts/bootstrap-template.py new file mode 100755 index 0000000000..7b947d0cf5 --- /dev/null +++ b/vortex-duckdb/scripts/bootstrap-template.py @@ -0,0 +1,200 @@ +#!/usr/bin/python3 + +import os +import re +import shutil +import sys +from pathlib import Path + + +def is_snake_case(s: str) -> bool: + """ + Check if the provided string is in snake_case format. + Snake case is lower case with words separated by underscores, and it can contain digits. + + Args: + s (str): String to check. + + Returns: + bool: True if the string is in snake_case, False otherwise. + """ + pattern = r"^[a-z0-9]+(_[a-z0-9]+)*$" + return bool(re.match(pattern, s)) + + +def to_camel_case(snake_str: str) -> str: + """ + Convert a snake_case string to camelCase. + + Args: + snake_str (str): String in snake_case to convert. + + Returns: + str: Converted string in camelCase. + """ + return "".join(x.capitalize() for x in snake_str.lower().split("_")) + + +def replace(file_name: str, to_find: str, to_replace: str) -> None: + """ + Replace occurrences of a string within a file, ensuring placeholders are handled. + The function replaces the `to_find` string with `to_replace`, adds a placeholder, + and skips lines with placeholders already in place. + + Args: + file_name (str): Path to the file to perform replacement in. + to_find (str): String to search for in the file. + to_replace (str): String to replace `to_find` with. + + Returns: + None + """ + with open(file_name, "r", encoding="utf8") as file: + filedata = file.readlines() + + new_filedata = [] + for line in filedata: + # Skip lines that have already been replaced by checking for placeholder + if "__REPLACEMENT_DONE__" in line: + new_filedata.append(line) + continue + + modified_line = line.replace( + to_find, + to_replace, + ) + modified_line = modified_line.replace( + to_find.capitalize(), to_camel_case(to_replace) + ) + modified_line = modified_line.replace( + to_find.upper(), + to_replace.upper(), + ) + + # Add placeholder once after all replacements + if to_find in line or to_find.capitalize() in line or to_find.upper() in line: + modified_line += "__REPLACEMENT_DONE__" + + new_filedata.append(modified_line) + + with open(file_name, "w", encoding="utf8") as file: + file.writelines(new_filedata) + + +def replace_everywhere(to_find: str, to_replace: str) -> None: + """ + Replace a string in all files in the project. + + Args: + to_find (str): String to search for in the file. + to_replace (str): String to replace `to_find` with. + + Returns: + None + """ + 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) + replace(".github/workflows/MainDistributionPipeline.yml", to_find, to_replace) + + +def remove_placeholder() -> None: + """ + Remove the placeholder from all files. + + Returns: + None + """ + for path in files_to_search: + replace_placeholders(path) + + replace_placeholders("./CMakeLists.txt") + replace_placeholders("./Makefile") + replace_placeholders("./Makefile") + replace_placeholders("./Makefile") + replace_placeholders("./README.md") + replace_placeholders("./extension_config.cmake") + replace_placeholders("./scripts/setup-custom-toolchain.sh") + + +def replace_placeholders(file_name: str) -> None: + """ + Remove the placeholder from a file. + + Args: + file_name (str): Path to the file to remove the placeholder from. + + Returns: + None + """ + with open(file_name, "r", encoding="utf8") as file: + filedata = file.read() + + # Remove all placeholders + filedata = filedata.replace("__REPLACEMENT_DONE__", "") + + with open(file_name, "w", encoding="utf8") as file: + file.write(filedata) + + +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) + + remove_placeholder() + + 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/vortex-duckdb/scripts/extension-upload.sh b/vortex-duckdb/scripts/extension-upload.sh new file mode 100755 index 0000000000..9fd5b39a94 --- /dev/null +++ b/vortex-duckdb/scripts/extension-upload.sh @@ -0,0 +1,90 @@ +#!/bin/bash + +# Extension upload script + +# Usage: ./extension-upload.sh +# : Name of the extension +# : Version (commit / version tag) of the extension +# : Version (commit / version tag) of DuckDB +# : Architecture target of the extension binary +# : S3 bucket to upload to +# : Set this as the latest version ("true" / "false", default: "false") +# : Set this as a versioned version that will prevent its deletion + +set -e + +if [[ $4 == wasm* ]]; then + ext="/tmp/extension/$1.duckdb_extension.wasm" +else + ext="/tmp/extension/$1.duckdb_extension" +fi + +echo $ext + +script_dir="$(dirname "$(readlink -f "$0")")" + +# calculate SHA256 hash of extension binary +cat $ext > $ext.append + +if [[ $4 == wasm* ]]; then + # 0 for custom section + # 113 in hex = 275 in decimal, total lenght of what follows (1 + 16 + 2 + 256) + # [1(continuation) + 0010011(payload) = \x93, 0(continuation) + 10(payload) = \x02] + echo -n -e '\x00' >> $ext.append + echo -n -e '\x93\x02' >> $ext.append + # 10 in hex = 16 in decimal, lenght of name, 1 byte + echo -n -e '\x10' >> $ext.append + echo -n -e 'duckdb_signature' >> $ext.append + # the name of the WebAssembly custom section, 16 bytes + # 100 in hex, 256 in decimal + # [1(continuation) + 0000000(payload) = ff, 0(continuation) + 10(payload)], + # for a grand total of 2 bytes + echo -n -e '\x80\x02' >> $ext.append +fi + +# (Optionally) Sign binary +if [ "$DUCKDB_EXTENSION_SIGNING_PK" != "" ]; then + echo "$DUCKDB_EXTENSION_SIGNING_PK" > private.pem + $script_dir/../duckdb/scripts/compute-extension-hash.sh $ext.append > $ext.hash + openssl pkeyutl -sign -in $ext.hash -inkey private.pem -pkeyopt digest:sha256 -out $ext.sign + rm -f private.pem +fi + +# Signature is always there, potentially defaulting to 256 zeros +truncate -s 256 $ext.sign + +# append signature to extension binary +cat $ext.sign >> $ext.append + +# compress extension binary +if [[ $4 == wasm_* ]]; then + brotli < $ext.append > "$ext.compressed" +else + gzip < $ext.append > "$ext.compressed" +fi + +set -e + +# Abort if AWS key is not set +if [ -z "$AWS_ACCESS_KEY_ID" ]; then + echo "No AWS key found, skipping.." + exit 0 +fi + +# upload versioned version +if [[ $7 = 'true' ]]; then + if [[ $4 == wasm* ]]; then + aws s3 cp $ext.compressed s3://$5/$1/$2/$3/$4/$1.duckdb_extension.wasm --acl public-read --content-encoding br --content-type="application/wasm" + else + aws s3 cp $ext.compressed s3://$5/$1/$2/$3/$4/$1.duckdb_extension.gz --acl public-read + fi +fi + +# upload to latest version +if [[ $6 = 'true' ]]; then + if [[ $4 == wasm* ]]; then + aws s3 cp $ext.compressed s3://$5/$3/$4/$1.duckdb_extension.wasm --acl public-read --content-encoding br --content-type="application/wasm" + else + aws s3 cp $ext.compressed s3://$5/$3/$4/$1.duckdb_extension.gz --acl public-read + fi +fi diff --git a/vortex-duckdb/scripts/setup-custom-toolchain.sh b/vortex-duckdb/scripts/setup-custom-toolchain.sh new file mode 100644 index 0000000000..4a846fcc9b --- /dev/null +++ b/vortex-duckdb/scripts/setup-custom-toolchain.sh @@ -0,0 +1,11 @@ +#!/bin/bash + +# This is an example script that can be used to install additional toolchain dependencies. Feel free to remove this script +# if no additional toolchains are required + +# To enable this script, set the `custom_toolchain_script` option to true when calling the reusable workflow +# `.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." + diff --git a/vortex-duckdb/src/include/quack_extension.hpp b/vortex-duckdb/src/include/quack_extension.hpp new file mode 100644 index 0000000000..494467b74d --- /dev/null +++ b/vortex-duckdb/src/include/quack_extension.hpp @@ -0,0 +1,14 @@ +#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/vortex-duckdb/src/quack_extension.cpp b/vortex-duckdb/src/quack_extension.cpp new file mode 100644 index 0000000000..61f2b410d3 --- /dev/null +++ b/vortex-duckdb/src/quack_extension.cpp @@ -0,0 +1,78 @@ +#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/vortex-duckdb/test/README.md b/vortex-duckdb/test/README.md new file mode 100644 index 0000000000..fb5e514f96 --- /dev/null +++ b/vortex-duckdb/test/README.md @@ -0,0 +1,11 @@ +# Testing this extension +This directory contains all the tests for this extension. The `sql` directory holds tests that are written as [SQLLogicTests](https://duckdb.org/dev/sqllogictest/intro.html). DuckDB aims to have most its tests in this format as SQL statements, so for the quack extension, this should probably be the goal too. + +The root makefile contains targets to build and run all of these tests. To run the SQLLogicTests: +```bash +make test +``` +or +```bash +make test_debug +``` \ No newline at end of file diff --git a/vortex-duckdb/test/sql/quack.test b/vortex-duckdb/test/sql/quack.test new file mode 100644 index 0000000000..519a354cc5 --- /dev/null +++ b/vortex-duckdb/test/sql/quack.test @@ -0,0 +1,23 @@ +# 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 diff --git a/vortex-duckdb/vcpkg.json b/vortex-duckdb/vcpkg.json new file mode 100644 index 0000000000..85936bf44c --- /dev/null +++ b/vortex-duckdb/vcpkg.json @@ -0,0 +1,5 @@ +{ + "dependencies": [ + "openssl" + ] +} \ No newline at end of file From 169ca5d7ab706ff4c59766fd50f3b96e5f141308 Mon Sep 17 00:00:00 2001 From: Joe Isaacs Date: Thu, 6 Mar 2025 12:15:46 +0000 Subject: [PATCH 04/12] cleanup --- .gitmodules | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/.gitmodules b/.gitmodules index 83344f6a93..da52057df0 100644 --- a/.gitmodules +++ b/.gitmodules @@ -5,10 +5,4 @@ [submodule "extension-ci-tools"] path = vortex-duckdb/extension-ci-tools url = https://github.com/duckdb/extension-ci-tools - branch = main -[submodule "duckdb"] - path = vortex-duckdb/duckdb - url = https://github.com/duckdb/duckdb -[submodule "extension-ci-tools"] - path = vortex-duckdb/extension-ci-tools - url = https://github.com/duckdb/extension-ci-tools + branch = main \ No newline at end of file From 707f83c234cf944971c8cf94f193fd9479619ec6 Mon Sep 17 00:00:00 2001 From: Joe Isaacs Date: Thu, 6 Mar 2025 13:41:24 +0000 Subject: [PATCH 05/12] update version --- .gitmodules | 4 +- vortex-duckdb/docs/README.md | 168 ++++++++++++++++++++++++------- vortex-duckdb/duckdb | 2 +- vortex-duckdb/extension-ci-tools | 2 +- 4 files changed, 133 insertions(+), 43 deletions(-) diff --git a/.gitmodules b/.gitmodules index da52057df0..e12cef0965 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,8 +1,6 @@ [submodule "duckdb"] path = vortex-duckdb/duckdb url = https://github.com/duckdb/duckdb - branch = main [submodule "extension-ci-tools"] path = vortex-duckdb/extension-ci-tools - url = https://github.com/duckdb/extension-ci-tools - branch = main \ No newline at end of file + url = https://github.com/duckdb/extension-ci-tools \ No newline at end of file diff --git a/vortex-duckdb/docs/README.md b/vortex-duckdb/docs/README.md index f057396919..6d81af8c74 100644 --- a/vortex-duckdb/docs/README.md +++ b/vortex-duckdb/docs/README.md @@ -1,41 +1,72 @@ # 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. + +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 + +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: + +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. + +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. + +### Install `pkg-config` + +```shell +brew install pkg-config +``` ### 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. + +- `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. ### Tips for speedy builds -DuckDB extensions currently rely on DuckDB's build system to provide easy testing and distributing. This does however come at the downside of requiring the template to build DuckDB and its unittest binary every time you build your extension. To mitigate this, we highly recommend installing [ccache](https://ccache.dev/) and [ninja](https://ninja-build.org/). This will ensure you only need to build core DuckDB once and allows for rapid rebuilds. + +DuckDB extensions currently rely on DuckDB's build system to provide easy testing and distributing. This does however +come at the downside of requiring the template to build DuckDB and its unittest binary every time you build your +extension. To mitigate this, we highly recommend installing [ccache](https://ccache.dev/) +and [ninja](https://ninja-build.org/). This will ensure you only need to build core DuckDB once and allows for rapid +rebuilds. To build using ninja and ccache ensure both are installed and run: @@ -44,9 +75,13 @@ GEN=ninja make ``` ## 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: +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; ┌───────────────┐ @@ -58,19 +93,26 @@ D select quack('Jane') as result; ``` ## 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 ``` ## 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; @@ -82,65 +124,115 @@ D select ('Jane') as result; └─────────────────────────────────────┘ ``` -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). +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 + To distribute your extension binaries, there are a few options. ### Community extensions -The recommended way of distributing extensions is through the [community extensions repository](https://github.com/duckdb/community-extensions). -This repository is designed specifically for extensions that are built using this extension template, meaning that as long as your extension can be -built using the default CI in this template, submitting it to the community extensions is a very simple process. The process works similarly to popular -package managers like homebrew and vcpkg, where a PR containing a descriptor file is submitted to the package manager repository. After the CI in the + +The recommended way of distributing extensions is through +the [community extensions repository](https://github.com/duckdb/community-extensions). +This repository is designed specifically for extensions that are built using this extension template, meaning that as +long as your extension can be +built using the default CI in this template, submitting it to the community extensions is a very simple process. The +process works similarly to popular +package managers like homebrew and vcpkg, where a PR containing a descriptor file is submitted to the package manager +repository. After the CI in the community extensions repository completes, the extension can be installed and loaded in DuckDB with: + ```SQL -INSTALL FROM community; -LOAD +INSTALL + FROM community; +LOAD + ``` -For more information, see the [community extensions documentation](https://duckdb.org/community_extensions/documentation). + +For more information, see +the [community extensions documentation](https://duckdb.org/community_extensions/documentation). ### Downloading artifacts from GitHub -The default CI in this template will automatically upload the binaries for every push to the main branch as GitHub Actions artifacts. These + +The default CI in this template will automatically upload the binaries for every push to the main branch as GitHub +Actions artifacts. These can be downloaded manually and then loaded directly using: + ```SQL -LOAD '/path/to/downloaded/extension.duckdb_extension'; +LOAD +'/path/to/downloaded/extension.duckdb_extension'; ``` + Note that this will require starting DuckDB with the -`allow_unsigned_extensions` option set to true. How to set this will depend on the client you're using. For the CLI it is done like: +`allow_unsigned_extensions` option set to true. How to set this will depend on the client you're using. For the CLI it +is done like: + ```shell duckdb -unsigned ``` ### Uploading to a custom repository -If for some reason distributing through community extensions is not an option, extensions can also be uploaded to a custom extension repository. -This will give some more control over where and how the extensions are distributed, but comes with the downside of requiring the `allow_unsigned_extensions` -option to be set. For examples of how to configure a manual GitHub Actions deploy pipeline, check out the extension deploy script in https://github.com/duckdb/extension-ci-tools. -Some examples of extensions that use this CI/CD workflow check out [spatial](https://github.com/duckdblabs/duckdb_spatial) or [aws](https://github.com/duckdb/duckdb_aws). + +If for some reason distributing through community extensions is not an option, extensions can also be uploaded to a +custom extension repository. +This will give some more control over where and how the extensions are distributed, but comes with the downside of +requiring the `allow_unsigned_extensions` +option to be set. For examples of how to configure a manual GitHub Actions deploy pipeline, check out the extension +deploy script in https://github.com/duckdb/extension-ci-tools. +Some examples of extensions that use this CI/CD workflow check +out [spatial](https://github.com/duckdblabs/duckdb_spatial) or [aws](https://github.com/duckdb/duckdb_aws). Extensions in custom repositories can be installed and loaded using: + ```SQL -INSTALL FROM 'http://my-custom-repo' +INSTALL + FROM 'http://my-custom-repo' 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 + +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 +## 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. + +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. +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/vortex-duckdb/duckdb b/vortex-duckdb/duckdb index 1df191691f..5f5512b827 160000 --- a/vortex-duckdb/duckdb +++ b/vortex-duckdb/duckdb @@ -1 +1 @@ -Subproject commit 1df191691fb616dda6d3f5c5e350f0ca3d8e656b +Subproject commit 5f5512b827df6397afd31daedb4bbdee76520019 diff --git a/vortex-duckdb/extension-ci-tools b/vortex-duckdb/extension-ci-tools index 9ca0be81af..58970c538d 160000 --- a/vortex-duckdb/extension-ci-tools +++ b/vortex-duckdb/extension-ci-tools @@ -1 +1 @@ -Subproject commit 9ca0be81af0c008e4561847633a80341e803258e +Subproject commit 58970c538d35919db875096460c05806056f4de0 From 51b6a07a1d3a45243295b70b896c0ce7921c601c Mon Sep 17 00:00:00 2001 From: Joe Isaacs Date: Thu, 6 Mar 2025 14:00:17 +0000 Subject: [PATCH 06/12] include cmake --- vortex-duckdb/.gitignore | 4 ++++ vortex-duckdb/CMakeLists.txt | 30 ++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 vortex-duckdb/CMakeLists.txt diff --git a/vortex-duckdb/.gitignore b/vortex-duckdb/.gitignore index b9f264b9aa..d1ca10b5bc 100644 --- a/vortex-duckdb/.gitignore +++ b/vortex-duckdb/.gitignore @@ -6,3 +6,7 @@ duckdb_unittest_tempdir/ testext test/python/__pycache__/ .Rhistory + +# Keep CMAKE + +!CMakeLists.txt \ No newline at end of file diff --git a/vortex-duckdb/CMakeLists.txt b/vortex-duckdb/CMakeLists.txt new file mode 100644 index 0000000000..10a5419605 --- /dev/null +++ b/vortex-duckdb/CMakeLists.txt @@ -0,0 +1,30 @@ +cmake_minimum_required(VERSION 3.5) + +# Set extension name here +set(TARGET_NAME quack) + +# 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(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) + +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) + +install( + TARGETS ${EXTENSION_NAME} + EXPORT "${DUCKDB_EXPORT_SET}" + LIBRARY DESTINATION "${INSTALL_LIB_DIR}" + ARCHIVE DESTINATION "${INSTALL_LIB_DIR}") \ No newline at end of file From 525454e2a1839e2677c58c6229d1247b480394a9 Mon Sep 17 00:00:00 2001 From: Joe Isaacs Date: Thu, 6 Mar 2025 14:03:29 +0000 Subject: [PATCH 07/12] rename to vortex_duckdb --- .../.github/workflows/ExtensionTemplate.yml | 162 ------------ .../workflows/MainDistributionPipeline.yml | 4 +- vortex-duckdb/CMakeLists.txt | 4 +- vortex-duckdb/Makefile | 2 +- vortex-duckdb/docs/NEXT_README.md | 86 ------- vortex-duckdb/docs/README.md | 238 ------------------ vortex-duckdb/extension_config.cmake | 2 +- vortex-duckdb/scripts/bootstrap-template.py | 200 --------------- .../scripts/setup-custom-toolchain.sh | 2 +- vortex-duckdb/src/include/quack_extension.hpp | 14 -- vortex-duckdb/src/quack_extension.cpp | 78 ------ vortex-duckdb/test/sql/quack.test | 23 -- 12 files changed, 7 insertions(+), 808 deletions(-) delete mode 100644 vortex-duckdb/.github/workflows/ExtensionTemplate.yml delete mode 100644 vortex-duckdb/docs/NEXT_README.md delete mode 100644 vortex-duckdb/docs/README.md delete mode 100755 vortex-duckdb/scripts/bootstrap-template.py delete mode 100644 vortex-duckdb/src/include/quack_extension.hpp delete mode 100644 vortex-duckdb/src/quack_extension.cpp delete mode 100644 vortex-duckdb/test/sql/quack.test diff --git a/vortex-duckdb/.github/workflows/ExtensionTemplate.yml b/vortex-duckdb/.github/workflows/ExtensionTemplate.yml deleted file mode 100644 index 971253257e..0000000000 --- a/vortex-duckdb/.github/workflows/ExtensionTemplate.yml +++ /dev/null @@ -1,162 +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 - 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 Ninja - shell: bash - run: sudo apt-get update -y -qq && sudo apt-get install -y -qq ninja-build - - - uses: actions/checkout@v4 - with: - fetch-depth: 0 - submodules: 'true' - - - 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: | - 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@v4 - 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@v4 - 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/vortex-duckdb/.github/workflows/MainDistributionPipeline.yml b/vortex-duckdb/.github/workflows/MainDistributionPipeline.yml index 5fc278c18b..754a187e02 100644 --- a/vortex-duckdb/.github/workflows/MainDistributionPipeline.yml +++ b/vortex-duckdb/.github/workflows/MainDistributionPipeline.yml @@ -18,7 +18,7 @@ jobs: with: duckdb_version: main ci_tools_version: main - extension_name: quack + extension_name: vortex_duckdb duckdb-stable-build: name: Build extension binaries @@ -26,4 +26,4 @@ jobs: with: duckdb_version: v1.2.0 ci_tools_version: v1.2.0 - extension_name: quack \ No newline at end of file + extension_name: vortex_duckdb \ No newline at end of file diff --git a/vortex-duckdb/CMakeLists.txt b/vortex-duckdb/CMakeLists.txt index 10a5419605..60d2a72e17 100644 --- a/vortex-duckdb/CMakeLists.txt +++ b/vortex-duckdb/CMakeLists.txt @@ -1,7 +1,7 @@ cmake_minimum_required(VERSION 3.5) # Set extension name here -set(TARGET_NAME quack) +set(TARGET_NAME vortex_duckdb) # 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. @@ -14,7 +14,7 @@ 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/vortex_duckdb_extension.cpp) build_static_extension(${TARGET_NAME} ${EXTENSION_SOURCES}) build_loadable_extension(${TARGET_NAME} " " ${EXTENSION_SOURCES}) diff --git a/vortex-duckdb/Makefile b/vortex-duckdb/Makefile index e91db43b69..6a78ffe02d 100644 --- a/vortex-duckdb/Makefile +++ b/vortex-duckdb/Makefile @@ -1,7 +1,7 @@ PROJ_DIR := $(dir $(abspath $(lastword $(MAKEFILE_LIST)))) # Configuration of extension -EXT_NAME=quack +EXT_NAME=vortex_duckdb EXT_CONFIG=${PROJ_DIR}extension_config.cmake # Include the Makefile from extension-ci-tools diff --git a/vortex-duckdb/docs/NEXT_README.md b/vortex-duckdb/docs/NEXT_README.md deleted file mode 100644 index 96f0482a2a..0000000000 --- a/vortex-duckdb/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/vortex-duckdb/docs/README.md b/vortex-duckdb/docs/README.md deleted file mode 100644 index 6d81af8c74..0000000000 --- a/vortex-duckdb/docs/README.md +++ /dev/null @@ -1,238 +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. - -### Install `pkg-config` - -```shell -brew install pkg-config -``` - -### 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. - -### Tips for speedy builds - -DuckDB extensions currently rely on DuckDB's build system to provide easy testing and distributing. This does however -come at the downside of requiring the template to build DuckDB and its unittest binary every time you build your -extension. To mitigate this, we highly recommend installing [ccache](https://ccache.dev/) -and [ninja](https://ninja-build.org/). This will ensure you only need to build core DuckDB once and allows for rapid -rebuilds. - -To build using ninja and ccache ensure both are installed and run: - -```sh -GEN=ninja make -``` - -## 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 - -To distribute your extension binaries, there are a few options. - -### Community extensions - -The recommended way of distributing extensions is through -the [community extensions repository](https://github.com/duckdb/community-extensions). -This repository is designed specifically for extensions that are built using this extension template, meaning that as -long as your extension can be -built using the default CI in this template, submitting it to the community extensions is a very simple process. The -process works similarly to popular -package managers like homebrew and vcpkg, where a PR containing a descriptor file is submitted to the package manager -repository. After the CI in the -community extensions repository completes, the extension can be installed and loaded in DuckDB with: - -```SQL -INSTALL - FROM community; -LOAD - -``` - -For more information, see -the [community extensions documentation](https://duckdb.org/community_extensions/documentation). - -### Downloading artifacts from GitHub - -The default CI in this template will automatically upload the binaries for every push to the main branch as GitHub -Actions artifacts. These -can be downloaded manually and then loaded directly using: - -```SQL -LOAD -'/path/to/downloaded/extension.duckdb_extension'; -``` - -Note that this will require starting DuckDB with the -`allow_unsigned_extensions` option set to true. How to set this will depend on the client you're using. For the CLI it -is done like: - -```shell -duckdb -unsigned -``` - -### Uploading to a custom repository - -If for some reason distributing through community extensions is not an option, extensions can also be uploaded to a -custom extension repository. -This will give some more control over where and how the extensions are distributed, but comes with the downside of -requiring the `allow_unsigned_extensions` -option to be set. For examples of how to configure a manual GitHub Actions deploy pipeline, check out the extension -deploy script in https://github.com/duckdb/extension-ci-tools. -Some examples of extensions that use this CI/CD workflow check -out [spatial](https://github.com/duckdblabs/duckdb_spatial) or [aws](https://github.com/duckdb/duckdb_aws). - -Extensions in custom repositories can be installed and loaded using: - -```SQL -INSTALL - FROM 'http://my-custom-repo' -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/vortex-duckdb/extension_config.cmake b/vortex-duckdb/extension_config.cmake index 959e702d93..0fab5f5844 100644 --- a/vortex-duckdb/extension_config.cmake +++ b/vortex-duckdb/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(vortex_duckdb SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR} LOAD_TESTS ) diff --git a/vortex-duckdb/scripts/bootstrap-template.py b/vortex-duckdb/scripts/bootstrap-template.py deleted file mode 100755 index 7b947d0cf5..0000000000 --- a/vortex-duckdb/scripts/bootstrap-template.py +++ /dev/null @@ -1,200 +0,0 @@ -#!/usr/bin/python3 - -import os -import re -import shutil -import sys -from pathlib import Path - - -def is_snake_case(s: str) -> bool: - """ - Check if the provided string is in snake_case format. - Snake case is lower case with words separated by underscores, and it can contain digits. - - Args: - s (str): String to check. - - Returns: - bool: True if the string is in snake_case, False otherwise. - """ - pattern = r"^[a-z0-9]+(_[a-z0-9]+)*$" - return bool(re.match(pattern, s)) - - -def to_camel_case(snake_str: str) -> str: - """ - Convert a snake_case string to camelCase. - - Args: - snake_str (str): String in snake_case to convert. - - Returns: - str: Converted string in camelCase. - """ - return "".join(x.capitalize() for x in snake_str.lower().split("_")) - - -def replace(file_name: str, to_find: str, to_replace: str) -> None: - """ - Replace occurrences of a string within a file, ensuring placeholders are handled. - The function replaces the `to_find` string with `to_replace`, adds a placeholder, - and skips lines with placeholders already in place. - - Args: - file_name (str): Path to the file to perform replacement in. - to_find (str): String to search for in the file. - to_replace (str): String to replace `to_find` with. - - Returns: - None - """ - with open(file_name, "r", encoding="utf8") as file: - filedata = file.readlines() - - new_filedata = [] - for line in filedata: - # Skip lines that have already been replaced by checking for placeholder - if "__REPLACEMENT_DONE__" in line: - new_filedata.append(line) - continue - - modified_line = line.replace( - to_find, - to_replace, - ) - modified_line = modified_line.replace( - to_find.capitalize(), to_camel_case(to_replace) - ) - modified_line = modified_line.replace( - to_find.upper(), - to_replace.upper(), - ) - - # Add placeholder once after all replacements - if to_find in line or to_find.capitalize() in line or to_find.upper() in line: - modified_line += "__REPLACEMENT_DONE__" - - new_filedata.append(modified_line) - - with open(file_name, "w", encoding="utf8") as file: - file.writelines(new_filedata) - - -def replace_everywhere(to_find: str, to_replace: str) -> None: - """ - Replace a string in all files in the project. - - Args: - to_find (str): String to search for in the file. - to_replace (str): String to replace `to_find` with. - - Returns: - None - """ - 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) - replace(".github/workflows/MainDistributionPipeline.yml", to_find, to_replace) - - -def remove_placeholder() -> None: - """ - Remove the placeholder from all files. - - Returns: - None - """ - for path in files_to_search: - replace_placeholders(path) - - replace_placeholders("./CMakeLists.txt") - replace_placeholders("./Makefile") - replace_placeholders("./Makefile") - replace_placeholders("./Makefile") - replace_placeholders("./README.md") - replace_placeholders("./extension_config.cmake") - replace_placeholders("./scripts/setup-custom-toolchain.sh") - - -def replace_placeholders(file_name: str) -> None: - """ - Remove the placeholder from a file. - - Args: - file_name (str): Path to the file to remove the placeholder from. - - Returns: - None - """ - with open(file_name, "r", encoding="utf8") as file: - filedata = file.read() - - # Remove all placeholders - filedata = filedata.replace("__REPLACEMENT_DONE__", "") - - with open(file_name, "w", encoding="utf8") as file: - file.write(filedata) - - -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) - - remove_placeholder() - - 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/vortex-duckdb/scripts/setup-custom-toolchain.sh b/vortex-duckdb/scripts/setup-custom-toolchain.sh index 4a846fcc9b..4a9273cd65 100644 --- a/vortex-duckdb/scripts/setup-custom-toolchain.sh +++ b/vortex-duckdb/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 vortex_duckdb extension." diff --git a/vortex-duckdb/src/include/quack_extension.hpp b/vortex-duckdb/src/include/quack_extension.hpp deleted file mode 100644 index 494467b74d..0000000000 --- a/vortex-duckdb/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/vortex-duckdb/src/quack_extension.cpp b/vortex-duckdb/src/quack_extension.cpp deleted file mode 100644 index 61f2b410d3..0000000000 --- a/vortex-duckdb/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/vortex-duckdb/test/sql/quack.test b/vortex-duckdb/test/sql/quack.test deleted file mode 100644 index 519a354cc5..0000000000 --- a/vortex-duckdb/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 From 3cd35d0ffd34fbc01d08ccaa72913f0bfe4ed12e Mon Sep 17 00:00:00 2001 From: Joe Isaacs Date: Thu, 6 Mar 2025 14:03:59 +0000 Subject: [PATCH 08/12] use duckdb --- vortex-duckdb/README.md | 124 ++++++++++++++++++ .../src/include/vortex_duckdb_extension.hpp | 14 ++ vortex-duckdb/src/vortex_duckdb_extension.cpp | 78 +++++++++++ vortex-duckdb/test/sql/vortex_duckdb.test | 23 ++++ 4 files changed, 239 insertions(+) create mode 100644 vortex-duckdb/README.md create mode 100644 vortex-duckdb/src/include/vortex_duckdb_extension.hpp create mode 100644 vortex-duckdb/src/vortex_duckdb_extension.cpp create mode 100644 vortex-duckdb/test/sql/vortex_duckdb.test diff --git a/vortex-duckdb/README.md b/vortex-duckdb/README.md new file mode 100644 index 0000000000..e030d976c6 --- /dev/null +++ b/vortex-duckdb/README.md @@ -0,0 +1,124 @@ +# 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 extension, VortexDuckdb, allow you to ... . + +## 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: + +```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/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. +- `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 +`vortex_duckdb()` that takes a string arguments and returns a string: + +``` +D select vortex_duckdb('Jane') as result; +┌───────────────┐ +│ result │ +│ varchar │ +├───────────────┤ +│ 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: + +```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 +vortex_duckdb +LOAD vortex_duckdb +``` diff --git a/vortex-duckdb/src/include/vortex_duckdb_extension.hpp b/vortex-duckdb/src/include/vortex_duckdb_extension.hpp new file mode 100644 index 0000000000..549f4b8f4f --- /dev/null +++ b/vortex-duckdb/src/include/vortex_duckdb_extension.hpp @@ -0,0 +1,14 @@ +#pragma once + +#include "duckdb.hpp" + +namespace duckdb { + +class VortexDuckdbExtension : public Extension { +public: + void Load(DuckDB &db) override; + std::string Name() override; + std::string Version() const override; +}; + +} // namespace duckdb diff --git a/vortex-duckdb/src/vortex_duckdb_extension.cpp b/vortex-duckdb/src/vortex_duckdb_extension.cpp new file mode 100644 index 0000000000..42465fa671 --- /dev/null +++ b/vortex-duckdb/src/vortex_duckdb_extension.cpp @@ -0,0 +1,78 @@ +#define DUCKDB_EXTENSION_MAIN + +#include "vortex_duckdb_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 VortexDuckdbScalarFun(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, "VortexDuckdb "+name.GetString()+" 🐥"); + }); +} + +inline void VortexDuckdbOpenSSLVersionScalarFun(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, "VortexDuckdb " + name.GetString() + + ", my linked OpenSSL version is " + + OPENSSL_VERSION_TEXT ); + }); +} + +static void LoadInternal(DatabaseInstance &instance) { + // Register a scalar function + auto vortex_duckdb_scalar_function = ScalarFunction("vortex_duckdb", {LogicalType::VARCHAR}, LogicalType::VARCHAR, VortexDuckdbScalarFun); + ExtensionUtil::RegisterFunction(instance, vortex_duckdb_scalar_function); + + // Register another scalar function + auto vortex_duckdb_openssl_version_scalar_function = ScalarFunction("vortex_duckdb_openssl_version", {LogicalType::VARCHAR}, + LogicalType::VARCHAR, VortexDuckdbOpenSSLVersionScalarFun); + ExtensionUtil::RegisterFunction(instance, vortex_duckdb_openssl_version_scalar_function); +} + +void VortexDuckdbExtension::Load(DuckDB &db) { + LoadInternal(*db.instance); +} +std::string VortexDuckdbExtension::Name() { + return "vortex_duckdb"; +} + +std::string VortexDuckdbExtension::Version() const { +#ifdef EXT_VERSION_VORTEX_DUCKDB + return EXT_VERSION_VORTEX_DUCKDB; +#else + return ""; +#endif +} + +} // namespace duckdb + +extern "C" { + +DUCKDB_EXTENSION_API void vortex_duckdb_init(duckdb::DatabaseInstance &db) { + duckdb::DuckDB db_wrapper(db); + db_wrapper.LoadExtension(); +} + +DUCKDB_EXTENSION_API const char *vortex_duckdb_version() { + return duckdb::DuckDB::LibraryVersion(); +} +} + +#ifndef DUCKDB_EXTENSION_MAIN +#error DUCKDB_EXTENSION_MAIN not defined +#endif diff --git a/vortex-duckdb/test/sql/vortex_duckdb.test b/vortex-duckdb/test/sql/vortex_duckdb.test new file mode 100644 index 0000000000..29ff64503b --- /dev/null +++ b/vortex-duckdb/test/sql/vortex_duckdb.test @@ -0,0 +1,23 @@ +# name: test/sql/vortex_duckdb.test +# description: test vortex_duckdb extension +# group: [vortex_duckdb] + +# Before we load the extension, this will fail +statement error +SELECT vortex_duckdb('Sam'); +---- +Catalog Error: Scalar Function with name vortex_duckdb does not exist! + +# Require statement will ensure this test is run with this extension loaded +require vortex_duckdb + +# Confirm the extension works +query I +SELECT vortex_duckdb('Sam'); +---- +VortexDuckdb Sam 🐥 + +query I +SELECT vortex_duckdb_openssl_version('Michael') ILIKE 'VortexDuckdb Michael, my linked OpenSSL version is OpenSSL%'; +---- +true From d779dcb58b998ee293e53f46a7331f7c87e0d729 Mon Sep 17 00:00:00 2001 From: Joe Isaacs Date: Thu, 6 Mar 2025 14:06:12 +0000 Subject: [PATCH 09/12] update modules --- .gitmodules | 4 ++-- {vortex-duckdb => duckdb}/.clang-format | 0 {vortex-duckdb => duckdb}/.clang-tidy | 0 {vortex-duckdb => duckdb}/.editorconfig | 0 .../.github/workflows/MainDistributionPipeline.yml | 0 {vortex-duckdb => duckdb}/.gitignore | 0 {vortex-duckdb => duckdb}/CMakeLists.txt | 0 {vortex-duckdb => duckdb}/LICENSE | 0 {vortex-duckdb => duckdb}/Makefile | 0 {vortex-duckdb => duckdb}/README.md | 0 {vortex-duckdb => duckdb}/docs/UPDATING.md | 0 duckdb/duckdb | 1 + duckdb/extension-ci-tools | 1 + {vortex-duckdb => duckdb}/extension_config.cmake | 0 {vortex-duckdb => duckdb}/scripts/extension-upload.sh | 0 {vortex-duckdb => duckdb}/scripts/setup-custom-toolchain.sh | 0 .../src/include/vortex_duckdb_extension.hpp | 0 {vortex-duckdb => duckdb}/src/vortex_duckdb_extension.cpp | 0 {vortex-duckdb => duckdb}/test/README.md | 0 {vortex-duckdb => duckdb}/test/sql/vortex_duckdb.test | 0 {vortex-duckdb => duckdb}/vcpkg.json | 0 21 files changed, 4 insertions(+), 2 deletions(-) rename {vortex-duckdb => duckdb}/.clang-format (100%) rename {vortex-duckdb => duckdb}/.clang-tidy (100%) rename {vortex-duckdb => duckdb}/.editorconfig (100%) rename {vortex-duckdb => duckdb}/.github/workflows/MainDistributionPipeline.yml (100%) rename {vortex-duckdb => duckdb}/.gitignore (100%) rename {vortex-duckdb => duckdb}/CMakeLists.txt (100%) rename {vortex-duckdb => duckdb}/LICENSE (100%) rename {vortex-duckdb => duckdb}/Makefile (100%) rename {vortex-duckdb => duckdb}/README.md (100%) rename {vortex-duckdb => duckdb}/docs/UPDATING.md (100%) create mode 160000 duckdb/duckdb create mode 160000 duckdb/extension-ci-tools rename {vortex-duckdb => duckdb}/extension_config.cmake (100%) rename {vortex-duckdb => duckdb}/scripts/extension-upload.sh (100%) rename {vortex-duckdb => duckdb}/scripts/setup-custom-toolchain.sh (100%) rename {vortex-duckdb => duckdb}/src/include/vortex_duckdb_extension.hpp (100%) rename {vortex-duckdb => duckdb}/src/vortex_duckdb_extension.cpp (100%) rename {vortex-duckdb => duckdb}/test/README.md (100%) rename {vortex-duckdb => duckdb}/test/sql/vortex_duckdb.test (100%) rename {vortex-duckdb => duckdb}/vcpkg.json (100%) diff --git a/.gitmodules b/.gitmodules index e12cef0965..4417fc1ee9 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,6 +1,6 @@ [submodule "duckdb"] - path = vortex-duckdb/duckdb + path = duckdb/duckdb url = https://github.com/duckdb/duckdb [submodule "extension-ci-tools"] - path = vortex-duckdb/extension-ci-tools + path = duckdb/extension-ci-tools url = https://github.com/duckdb/extension-ci-tools \ No newline at end of file diff --git a/vortex-duckdb/.clang-format b/duckdb/.clang-format similarity index 100% rename from vortex-duckdb/.clang-format rename to duckdb/.clang-format diff --git a/vortex-duckdb/.clang-tidy b/duckdb/.clang-tidy similarity index 100% rename from vortex-duckdb/.clang-tidy rename to duckdb/.clang-tidy diff --git a/vortex-duckdb/.editorconfig b/duckdb/.editorconfig similarity index 100% rename from vortex-duckdb/.editorconfig rename to duckdb/.editorconfig diff --git a/vortex-duckdb/.github/workflows/MainDistributionPipeline.yml b/duckdb/.github/workflows/MainDistributionPipeline.yml similarity index 100% rename from vortex-duckdb/.github/workflows/MainDistributionPipeline.yml rename to duckdb/.github/workflows/MainDistributionPipeline.yml diff --git a/vortex-duckdb/.gitignore b/duckdb/.gitignore similarity index 100% rename from vortex-duckdb/.gitignore rename to duckdb/.gitignore diff --git a/vortex-duckdb/CMakeLists.txt b/duckdb/CMakeLists.txt similarity index 100% rename from vortex-duckdb/CMakeLists.txt rename to duckdb/CMakeLists.txt diff --git a/vortex-duckdb/LICENSE b/duckdb/LICENSE similarity index 100% rename from vortex-duckdb/LICENSE rename to duckdb/LICENSE diff --git a/vortex-duckdb/Makefile b/duckdb/Makefile similarity index 100% rename from vortex-duckdb/Makefile rename to duckdb/Makefile diff --git a/vortex-duckdb/README.md b/duckdb/README.md similarity index 100% rename from vortex-duckdb/README.md rename to duckdb/README.md diff --git a/vortex-duckdb/docs/UPDATING.md b/duckdb/docs/UPDATING.md similarity index 100% rename from vortex-duckdb/docs/UPDATING.md rename to duckdb/docs/UPDATING.md diff --git a/duckdb/duckdb b/duckdb/duckdb new file mode 160000 index 0000000000..5f5512b827 --- /dev/null +++ b/duckdb/duckdb @@ -0,0 +1 @@ +Subproject commit 5f5512b827df6397afd31daedb4bbdee76520019 diff --git a/duckdb/extension-ci-tools b/duckdb/extension-ci-tools new file mode 160000 index 0000000000..58970c538d --- /dev/null +++ b/duckdb/extension-ci-tools @@ -0,0 +1 @@ +Subproject commit 58970c538d35919db875096460c05806056f4de0 diff --git a/vortex-duckdb/extension_config.cmake b/duckdb/extension_config.cmake similarity index 100% rename from vortex-duckdb/extension_config.cmake rename to duckdb/extension_config.cmake diff --git a/vortex-duckdb/scripts/extension-upload.sh b/duckdb/scripts/extension-upload.sh similarity index 100% rename from vortex-duckdb/scripts/extension-upload.sh rename to duckdb/scripts/extension-upload.sh diff --git a/vortex-duckdb/scripts/setup-custom-toolchain.sh b/duckdb/scripts/setup-custom-toolchain.sh similarity index 100% rename from vortex-duckdb/scripts/setup-custom-toolchain.sh rename to duckdb/scripts/setup-custom-toolchain.sh diff --git a/vortex-duckdb/src/include/vortex_duckdb_extension.hpp b/duckdb/src/include/vortex_duckdb_extension.hpp similarity index 100% rename from vortex-duckdb/src/include/vortex_duckdb_extension.hpp rename to duckdb/src/include/vortex_duckdb_extension.hpp diff --git a/vortex-duckdb/src/vortex_duckdb_extension.cpp b/duckdb/src/vortex_duckdb_extension.cpp similarity index 100% rename from vortex-duckdb/src/vortex_duckdb_extension.cpp rename to duckdb/src/vortex_duckdb_extension.cpp diff --git a/vortex-duckdb/test/README.md b/duckdb/test/README.md similarity index 100% rename from vortex-duckdb/test/README.md rename to duckdb/test/README.md diff --git a/vortex-duckdb/test/sql/vortex_duckdb.test b/duckdb/test/sql/vortex_duckdb.test similarity index 100% rename from vortex-duckdb/test/sql/vortex_duckdb.test rename to duckdb/test/sql/vortex_duckdb.test diff --git a/vortex-duckdb/vcpkg.json b/duckdb/vcpkg.json similarity index 100% rename from vortex-duckdb/vcpkg.json rename to duckdb/vcpkg.json From ec0b555ef02092d3eb5fd913f04a9b0b6f3ca8c3 Mon Sep 17 00:00:00 2001 From: Joe Isaacs Date: Thu, 6 Mar 2025 14:06:34 +0000 Subject: [PATCH 10/12] move to duckdb --- vortex-duckdb/duckdb | 1 - vortex-duckdb/extension-ci-tools | 1 - 2 files changed, 2 deletions(-) delete mode 160000 vortex-duckdb/duckdb delete mode 160000 vortex-duckdb/extension-ci-tools diff --git a/vortex-duckdb/duckdb b/vortex-duckdb/duckdb deleted file mode 160000 index 5f5512b827..0000000000 --- a/vortex-duckdb/duckdb +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 5f5512b827df6397afd31daedb4bbdee76520019 diff --git a/vortex-duckdb/extension-ci-tools b/vortex-duckdb/extension-ci-tools deleted file mode 160000 index 58970c538d..0000000000 --- a/vortex-duckdb/extension-ci-tools +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 58970c538d35919db875096460c05806056f4de0 From fa3319323ff94ebfff59cedf29de0b3447fe84b1 Mon Sep 17 00:00:00 2001 From: Joe Isaacs Date: Thu, 6 Mar 2025 14:18:13 +0000 Subject: [PATCH 11/12] move to duckdb-vortex --- {duckdb => duckdb-vortex}/.clang-format | 0 {duckdb => duckdb-vortex}/.clang-tidy | 0 {duckdb => duckdb-vortex}/.editorconfig | 0 .../.github/workflows/MainDistributionPipeline.yml | 0 {duckdb => duckdb-vortex}/.gitignore | 0 {duckdb => duckdb-vortex}/CMakeLists.txt | 0 {duckdb => duckdb-vortex}/LICENSE | 0 {duckdb => duckdb-vortex}/Makefile | 0 {duckdb => duckdb-vortex}/README.md | 0 {duckdb => duckdb-vortex}/docs/UPDATING.md | 0 {duckdb => duckdb-vortex}/duckdb | 0 {duckdb => duckdb-vortex}/extension-ci-tools | 0 {duckdb => duckdb-vortex}/extension_config.cmake | 0 {duckdb => duckdb-vortex}/scripts/extension-upload.sh | 0 {duckdb => duckdb-vortex}/scripts/setup-custom-toolchain.sh | 0 {duckdb => duckdb-vortex}/src/include/vortex_duckdb_extension.hpp | 0 {duckdb => duckdb-vortex}/src/vortex_duckdb_extension.cpp | 0 {duckdb => duckdb-vortex}/test/README.md | 0 {duckdb => duckdb-vortex}/test/sql/vortex_duckdb.test | 0 {duckdb => duckdb-vortex}/vcpkg.json | 0 20 files changed, 0 insertions(+), 0 deletions(-) rename {duckdb => duckdb-vortex}/.clang-format (100%) rename {duckdb => duckdb-vortex}/.clang-tidy (100%) rename {duckdb => duckdb-vortex}/.editorconfig (100%) rename {duckdb => duckdb-vortex}/.github/workflows/MainDistributionPipeline.yml (100%) rename {duckdb => duckdb-vortex}/.gitignore (100%) rename {duckdb => duckdb-vortex}/CMakeLists.txt (100%) rename {duckdb => duckdb-vortex}/LICENSE (100%) rename {duckdb => duckdb-vortex}/Makefile (100%) rename {duckdb => duckdb-vortex}/README.md (100%) rename {duckdb => duckdb-vortex}/docs/UPDATING.md (100%) rename {duckdb => duckdb-vortex}/duckdb (100%) rename {duckdb => duckdb-vortex}/extension-ci-tools (100%) rename {duckdb => duckdb-vortex}/extension_config.cmake (100%) rename {duckdb => duckdb-vortex}/scripts/extension-upload.sh (100%) rename {duckdb => duckdb-vortex}/scripts/setup-custom-toolchain.sh (100%) rename {duckdb => duckdb-vortex}/src/include/vortex_duckdb_extension.hpp (100%) rename {duckdb => duckdb-vortex}/src/vortex_duckdb_extension.cpp (100%) rename {duckdb => duckdb-vortex}/test/README.md (100%) rename {duckdb => duckdb-vortex}/test/sql/vortex_duckdb.test (100%) rename {duckdb => duckdb-vortex}/vcpkg.json (100%) diff --git a/duckdb/.clang-format b/duckdb-vortex/.clang-format similarity index 100% rename from duckdb/.clang-format rename to duckdb-vortex/.clang-format diff --git a/duckdb/.clang-tidy b/duckdb-vortex/.clang-tidy similarity index 100% rename from duckdb/.clang-tidy rename to duckdb-vortex/.clang-tidy diff --git a/duckdb/.editorconfig b/duckdb-vortex/.editorconfig similarity index 100% rename from duckdb/.editorconfig rename to duckdb-vortex/.editorconfig diff --git a/duckdb/.github/workflows/MainDistributionPipeline.yml b/duckdb-vortex/.github/workflows/MainDistributionPipeline.yml similarity index 100% rename from duckdb/.github/workflows/MainDistributionPipeline.yml rename to duckdb-vortex/.github/workflows/MainDistributionPipeline.yml diff --git a/duckdb/.gitignore b/duckdb-vortex/.gitignore similarity index 100% rename from duckdb/.gitignore rename to duckdb-vortex/.gitignore diff --git a/duckdb/CMakeLists.txt b/duckdb-vortex/CMakeLists.txt similarity index 100% rename from duckdb/CMakeLists.txt rename to duckdb-vortex/CMakeLists.txt diff --git a/duckdb/LICENSE b/duckdb-vortex/LICENSE similarity index 100% rename from duckdb/LICENSE rename to duckdb-vortex/LICENSE diff --git a/duckdb/Makefile b/duckdb-vortex/Makefile similarity index 100% rename from duckdb/Makefile rename to duckdb-vortex/Makefile diff --git a/duckdb/README.md b/duckdb-vortex/README.md similarity index 100% rename from duckdb/README.md rename to duckdb-vortex/README.md diff --git a/duckdb/docs/UPDATING.md b/duckdb-vortex/docs/UPDATING.md similarity index 100% rename from duckdb/docs/UPDATING.md rename to duckdb-vortex/docs/UPDATING.md diff --git a/duckdb/duckdb b/duckdb-vortex/duckdb similarity index 100% rename from duckdb/duckdb rename to duckdb-vortex/duckdb diff --git a/duckdb/extension-ci-tools b/duckdb-vortex/extension-ci-tools similarity index 100% rename from duckdb/extension-ci-tools rename to duckdb-vortex/extension-ci-tools diff --git a/duckdb/extension_config.cmake b/duckdb-vortex/extension_config.cmake similarity index 100% rename from duckdb/extension_config.cmake rename to duckdb-vortex/extension_config.cmake diff --git a/duckdb/scripts/extension-upload.sh b/duckdb-vortex/scripts/extension-upload.sh similarity index 100% rename from duckdb/scripts/extension-upload.sh rename to duckdb-vortex/scripts/extension-upload.sh diff --git a/duckdb/scripts/setup-custom-toolchain.sh b/duckdb-vortex/scripts/setup-custom-toolchain.sh similarity index 100% rename from duckdb/scripts/setup-custom-toolchain.sh rename to duckdb-vortex/scripts/setup-custom-toolchain.sh diff --git a/duckdb/src/include/vortex_duckdb_extension.hpp b/duckdb-vortex/src/include/vortex_duckdb_extension.hpp similarity index 100% rename from duckdb/src/include/vortex_duckdb_extension.hpp rename to duckdb-vortex/src/include/vortex_duckdb_extension.hpp diff --git a/duckdb/src/vortex_duckdb_extension.cpp b/duckdb-vortex/src/vortex_duckdb_extension.cpp similarity index 100% rename from duckdb/src/vortex_duckdb_extension.cpp rename to duckdb-vortex/src/vortex_duckdb_extension.cpp diff --git a/duckdb/test/README.md b/duckdb-vortex/test/README.md similarity index 100% rename from duckdb/test/README.md rename to duckdb-vortex/test/README.md diff --git a/duckdb/test/sql/vortex_duckdb.test b/duckdb-vortex/test/sql/vortex_duckdb.test similarity index 100% rename from duckdb/test/sql/vortex_duckdb.test rename to duckdb-vortex/test/sql/vortex_duckdb.test diff --git a/duckdb/vcpkg.json b/duckdb-vortex/vcpkg.json similarity index 100% rename from duckdb/vcpkg.json rename to duckdb-vortex/vcpkg.json From 0e07bd27d2e635127892b978d1f5075035622037 Mon Sep 17 00:00:00 2001 From: Joe Isaacs Date: Thu, 6 Mar 2025 14:48:33 +0000 Subject: [PATCH 12/12] update --- duckdb-vortex/src/vortex_duckdb_extension.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/duckdb-vortex/src/vortex_duckdb_extension.cpp b/duckdb-vortex/src/vortex_duckdb_extension.cpp index 42465fa671..8cd0426821 100644 --- a/duckdb-vortex/src/vortex_duckdb_extension.cpp +++ b/duckdb-vortex/src/vortex_duckdb_extension.cpp @@ -35,11 +35,11 @@ inline void VortexDuckdbOpenSSLVersionScalarFun(DataChunk &args, ExpressionState static void LoadInternal(DatabaseInstance &instance) { // Register a scalar function - auto vortex_duckdb_scalar_function = ScalarFunction("vortex_duckdb", {LogicalType::VARCHAR}, LogicalType::VARCHAR, VortexDuckdbScalarFun); + auto vortex_duckdb_scalar_function = ScalarFunction("vortex", {LogicalType::VARCHAR}, LogicalType::VARCHAR, VortexDuckdbScalarFun); ExtensionUtil::RegisterFunction(instance, vortex_duckdb_scalar_function); // Register another scalar function - auto vortex_duckdb_openssl_version_scalar_function = ScalarFunction("vortex_duckdb_openssl_version", {LogicalType::VARCHAR}, + auto vortex_duckdb_openssl_version_scalar_function = ScalarFunction("vortex_openssl_version", {LogicalType::VARCHAR}, LogicalType::VARCHAR, VortexDuckdbOpenSSLVersionScalarFun); ExtensionUtil::RegisterFunction(instance, vortex_duckdb_openssl_version_scalar_function); }