From 56de97d84c8f40da320237b53360b04e6e7cdff7 Mon Sep 17 00:00:00 2001 From: Robert Sesek Date: Thu, 31 Jul 2025 05:58:19 -0400 Subject: [PATCH] ./scripts/bootstrap-template.py oslog --- .github/workflows/ExtensionTemplate.yml | 162 -------------- .../workflows/MainDistributionPipeline.yml | 6 +- CMakeLists.txt | 4 +- Makefile | 2 +- docs/NEXT_README.md => README.md | 18 +- docs/README.md | 146 ------------- extension_config.cmake | 2 +- scripts/bootstrap-template.py | 198 ------------------ ...uack_extension.hpp => oslog_extension.hpp} | 2 +- ...uack_extension.cpp => oslog_extension.cpp} | 38 ++-- test/sql/{quack.test => oslog.test} | 16 +- 11 files changed, 44 insertions(+), 550 deletions(-) delete mode 100644 .github/workflows/ExtensionTemplate.yml rename docs/NEXT_README.md => README.md (90%) delete mode 100644 docs/README.md delete mode 100755 scripts/bootstrap-template.py rename src/include/{quack_extension.hpp => oslog_extension.hpp} (82%) rename src/{quack_extension.cpp => oslog_extension.cpp} (55%) rename test/sql/{quack.test => oslog.test} (50%) diff --git a/.github/workflows/ExtensionTemplate.yml b/.github/workflows/ExtensionTemplate.yml deleted file mode 100644 index 16faf17..0000000 --- a/.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: 5e5d0e1cd7785623065e77eff011afdeec1a3574 - - - 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: 5e5d0e1cd7785623065e77eff011afdeec1a3574 - - - 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: 5e5d0e1cd7785623065e77eff011afdeec1a3574 - - - 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 diff --git a/.github/workflows/MainDistributionPipeline.yml b/.github/workflows/MainDistributionPipeline.yml index 95aab61..058fc23 100644 --- a/.github/workflows/MainDistributionPipeline.yml +++ b/.github/workflows/MainDistributionPipeline.yml @@ -20,7 +20,7 @@ jobs: with: duckdb_version: main ci_tools_version: main - extension_name: quack + extension_name: oslog duckdb-stable-build: name: Build extension binaries @@ -28,7 +28,7 @@ jobs: with: duckdb_version: v1.3.2 ci_tools_version: v1.3.2 - extension_name: quack + extension_name: oslog code-quality-check: name: Code Quality Check @@ -36,5 +36,5 @@ jobs: with: duckdb_version: v1.3.2 ci_tools_version: main - extension_name: quack + extension_name: oslog format_checks: 'format;tidy' diff --git a/CMakeLists.txt b/CMakeLists.txt index 1d144aa..a4dffe3 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,7 +1,7 @@ cmake_minimum_required(VERSION 3.5) # Set extension name here -set(TARGET_NAME quack) +set(TARGET_NAME oslog) # 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/oslog_extension.cpp) build_static_extension(${TARGET_NAME} ${EXTENSION_SOURCES}) build_loadable_extension(${TARGET_NAME} " " ${EXTENSION_SOURCES}) diff --git a/Makefile b/Makefile index e91db43..16ce860 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ PROJ_DIR := $(dir $(abspath $(lastword $(MAKEFILE_LIST)))) # Configuration of extension -EXT_NAME=quack +EXT_NAME=oslog EXT_CONFIG=${PROJ_DIR}extension_config.cmake # Include the Makefile from extension-ci-tools diff --git a/docs/NEXT_README.md b/README.md similarity index 90% rename from docs/NEXT_README.md rename to README.md index 96f0482..4163ba9 100644 --- a/docs/NEXT_README.md +++ b/README.md @@ -1,10 +1,10 @@ -# Quack +# Oslog 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 ... . +This extension, Oslog, allow you to ... . ## Building @@ -26,23 +26,23 @@ The main binaries that will be built are: ```sh ./build/release/duckdb ./build/release/test/unittest -./build/release/extension/quack/quack.duckdb_extension +./build/release/extension/oslog/oslog.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. +- `oslog.duckdb_extension` is the loadable binary as it would be distributed. ## Running the extension To run the extension code, simply start the shell with `./build/release/duckdb`. -Now we can use the features from the extension directly in DuckDB. The template contains a single scalar function `quack()` that takes a string arguments and returns a string: +Now we can use the features from the extension directly in DuckDB. The template contains a single scalar function `oslog()` that takes a string arguments and returns a string: ``` -D select quack('Jane') as result; +D select oslog('Jane') as result; ┌───────────────┐ │ result │ │ varchar │ ├───────────────┤ -│ Quack Jane 🐥 │ +│ Oslog Jane 🐥 │ └───────────────┘ ``` @@ -81,6 +81,6 @@ DuckDB. To specify a specific version, you can pass the version instead. After running these steps, you can install and load your extension using the regular INSTALL/LOAD commands in DuckDB: ```sql -INSTALL quack -LOAD quack +INSTALL oslog +LOAD oslog ``` diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index f057396..0000000 --- a/docs/README.md +++ /dev/null @@ -1,146 +0,0 @@ -# DuckDB Extension Template -This repository contains a template for creating a DuckDB extension. The main goal of this template is to allow users to easily develop, test and distribute their own DuckDB extension. The main branch of the template is always based on the latest stable DuckDB allowing you to try out your extension right away. - -## Getting started -First step to getting started is to create your own repo from this template by clicking `Use this template`. Then clone your new repository using -```sh -git clone --recurse-submodules https://github.com//.git -``` -Note that `--recurse-submodules` will ensure DuckDB is pulled which is required to build the extension. - -## Building -### Managing dependencies -DuckDB extensions uses VCPKG for dependency management. Enabling VCPKG is very simple: follow the [installation instructions](https://vcpkg.io/en/getting-started) or just run the following: -```shell -cd -git clone https://github.com/Microsoft/vcpkg.git -sh ./vcpkg/scripts/bootstrap.sh -disableMetrics -export VCPKG_TOOLCHAIN_PATH=`pwd`/vcpkg/scripts/buildsystems/vcpkg.cmake -``` -Note: VCPKG is only required for extensions that want to rely on it for dependency management. If you want to develop an extension without dependencies, or want to do your own dependency management, just skip this step. Note that the example extension uses VCPKG to build with a dependency for instructive purposes, so when skipping this step the build may not work without removing the dependency. - -### Build steps -Now to build the extension, run: -```sh -make -``` -The main binaries that will be built are: -```sh -./build/release/duckdb -./build/release/test/unittest -./build/release/extension//.duckdb_extension -``` -- `duckdb` is the binary for the duckdb shell with the extension code automatically loaded. -- `unittest` is the test runner of duckdb. Again, the extension is already linked into the binary. -- `.duckdb_extension` is the loadable binary as it would be distributed. - -### 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/extension_config.cmake b/extension_config.cmake index 959e702..c44986c 100644 --- a/extension_config.cmake +++ b/extension_config.cmake @@ -1,7 +1,7 @@ # This file is included by DuckDB's build system. It specifies which extension to load # Extension from this repo -duckdb_extension_load(quack +duckdb_extension_load(oslog SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR} LOAD_TESTS ) diff --git a/scripts/bootstrap-template.py b/scripts/bootstrap-template.py deleted file mode 100755 index 30df0c9..0000000 --- a/scripts/bootstrap-template.py +++ /dev/null @@ -1,198 +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(".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") - - -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/src/include/quack_extension.hpp b/src/include/oslog_extension.hpp similarity index 82% rename from src/include/quack_extension.hpp rename to src/include/oslog_extension.hpp index 5e605be..2ce3917 100644 --- a/src/include/quack_extension.hpp +++ b/src/include/oslog_extension.hpp @@ -4,7 +4,7 @@ namespace duckdb { -class QuackExtension : public Extension { +class OslogExtension : public Extension { public: void Load(DuckDB &db) override; std::string Name() override; diff --git a/src/quack_extension.cpp b/src/oslog_extension.cpp similarity index 55% rename from src/quack_extension.cpp rename to src/oslog_extension.cpp index daa79a8..2928f79 100644 --- a/src/quack_extension.cpp +++ b/src/oslog_extension.cpp @@ -1,6 +1,6 @@ #define DUCKDB_EXTENSION_MAIN -#include "quack_extension.hpp" +#include "oslog_extension.hpp" #include "duckdb.hpp" #include "duckdb/common/exception.hpp" #include "duckdb/common/string_util.hpp" @@ -13,42 +13,42 @@ namespace duckdb { -inline void QuackScalarFun(DataChunk &args, ExpressionState &state, Vector &result) { +inline void OslogScalarFun(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() + " 🐥"); + return StringVector::AddString(result, "Oslog " + name.GetString() + " 🐥"); }); } -inline void QuackOpenSSLVersionScalarFun(DataChunk &args, ExpressionState &state, Vector &result) { +inline void OslogOpenSSLVersionScalarFun(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 " + + return StringVector::AddString(result, "Oslog " + 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); + auto oslog_scalar_function = ScalarFunction("oslog", {LogicalType::VARCHAR}, LogicalType::VARCHAR, OslogScalarFun); + ExtensionUtil::RegisterFunction(instance, oslog_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); + auto oslog_openssl_version_scalar_function = ScalarFunction("oslog_openssl_version", {LogicalType::VARCHAR}, + LogicalType::VARCHAR, OslogOpenSSLVersionScalarFun); + ExtensionUtil::RegisterFunction(instance, oslog_openssl_version_scalar_function); } -void QuackExtension::Load(DuckDB &db) { +void OslogExtension::Load(DuckDB &db) { LoadInternal(*db.instance); } -std::string QuackExtension::Name() { - return "quack"; +std::string OslogExtension::Name() { + return "oslog"; } -std::string QuackExtension::Version() const { -#ifdef EXT_VERSION_QUACK - return EXT_VERSION_QUACK; +std::string OslogExtension::Version() const { +#ifdef EXT_VERSION_OSLOG + return EXT_VERSION_OSLOG; #else return ""; #endif @@ -58,12 +58,12 @@ std::string QuackExtension::Version() const { extern "C" { -DUCKDB_EXTENSION_API void quack_init(duckdb::DatabaseInstance &db) { +DUCKDB_EXTENSION_API void oslog_init(duckdb::DatabaseInstance &db) { duckdb::DuckDB db_wrapper(db); - db_wrapper.LoadExtension(); + db_wrapper.LoadExtension(); } -DUCKDB_EXTENSION_API const char *quack_version() { +DUCKDB_EXTENSION_API const char *oslog_version() { return duckdb::DuckDB::LibraryVersion(); } } diff --git a/test/sql/quack.test b/test/sql/oslog.test similarity index 50% rename from test/sql/quack.test rename to test/sql/oslog.test index 6416c65..3724088 100644 --- a/test/sql/quack.test +++ b/test/sql/oslog.test @@ -1,23 +1,23 @@ -# name: test/sql/quack.test -# description: test quack extension +# name: test/sql/oslog.test +# description: test oslog extension # group: [sql] # Before we load the extension, this will fail statement error -SELECT quack('Sam'); +SELECT oslog('Sam'); ---- -Catalog Error: Scalar Function with name quack does not exist! +Catalog Error: Scalar Function with name oslog does not exist! # Require statement will ensure this test is run with this extension loaded -require quack +require oslog # Confirm the extension works query I -SELECT quack('Sam'); +SELECT oslog('Sam'); ---- -Quack Sam 🐥 +Oslog Sam 🐥 query I -SELECT quack_openssl_version('Michael') ILIKE 'Quack Michael, my linked OpenSSL version is OpenSSL%'; +SELECT oslog_openssl_version('Michael') ILIKE 'Oslog Michael, my linked OpenSSL version is OpenSSL%'; ---- true -- 2.43.5