{"id":30772183,"url":"https://github.com/query-farm/discreture","last_synced_at":"2025-09-05T00:52:43.247Z","repository":{"id":309244289,"uuid":"1035478232","full_name":"Query-farm/discreture","owner":"Query-farm","description":null,"archived":false,"fork":false,"pushed_at":"2025-08-10T18:28:15.000Z","size":14,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-10T20:31:21.476Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Query-farm.png","metadata":{"files":{"readme":"docs/README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-10T13:41:59.000Z","updated_at":"2025-08-10T18:28:18.000Z","dependencies_parsed_at":"2025-08-10T20:31:25.826Z","dependency_job_id":"14fea060-8d31-4f03-8e32-b29097692468","html_url":"https://github.com/Query-farm/discreture","commit_stats":null,"previous_names":["query-farm/discreture"],"tags_count":null,"template":false,"template_full_name":"duckdb/extension-template","purl":"pkg:github/Query-farm/discreture","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Query-farm%2Fdiscreture","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Query-farm%2Fdiscreture/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Query-farm%2Fdiscreture/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Query-farm%2Fdiscreture/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Query-farm","download_url":"https://codeload.github.com/Query-farm/discreture/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Query-farm%2Fdiscreture/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273695251,"owners_count":25151484,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-04T02:00:08.968Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-09-05T00:52:39.507Z","updated_at":"2025-09-05T00:52:43.219Z","avatar_url":"https://github.com/Query-farm.png","language":"C++","readme":"# DuckDB Extension Template\nThis 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.\n\n## Getting started\nFirst step to getting started is to create your own repo from this template by clicking `Use this template`. Then clone your new repository using\n```sh\ngit clone --recurse-submodules https://github.com/\u003cyou\u003e/\u003cyour-new-extension-repo\u003e.git\n```\nNote that `--recurse-submodules` will ensure DuckDB is pulled which is required to build the extension.\n\n## Building\n### Managing dependencies\nDuckDB 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:\n```shell\ncd \u003cyour-working-dir-not-the-plugin-repo\u003e\ngit clone https://github.com/Microsoft/vcpkg.git\nsh ./vcpkg/scripts/bootstrap.sh -disableMetrics\nexport VCPKG_TOOLCHAIN_PATH=`pwd`/vcpkg/scripts/buildsystems/vcpkg.cmake\n```\nNote: 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.\n\n### Build steps\nNow to build the extension, run:\n```sh\nmake\n```\nThe main binaries that will be built are:\n```sh\n./build/release/duckdb\n./build/release/test/unittest\n./build/release/extension/\u003cextension_name\u003e/\u003cextension_name\u003e.duckdb_extension\n```\n- `duckdb` is the binary for the duckdb shell with the extension code automatically loaded.\n- `unittest` is the test runner of duckdb. Again, the extension is already linked into the binary.\n- `\u003cextension_name\u003e.duckdb_extension` is the loadable binary as it would be distributed.\n\n### Tips for speedy builds\nDuckDB 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.\n\nTo build using ninja and ccache ensure both are installed and run:\n\n```sh\nGEN=ninja make\n```\n\n## Running the extension\nTo run the extension code, simply start the shell with `./build/release/duckdb`. This shell will have the extension pre-loaded.\n\nNow we can use the features from the extension directly in DuckDB. The template contains a single scalar function `discreture()` that takes a string arguments and returns a string:\n```\nD select discreture('Jane') as result;\n┌───────────────┐\n│    result     │\n│    varchar    │\n├───────────────┤\n│ Discreture Jane 🐥 │\n└───────────────┘\n```\n\n## Running the tests\nDifferent 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:\n```sh\nmake test\n```\n\n## Getting started with your own extension\nAfter creating a repository from this template, the first step is to name your extension. To rename the extension, run:\n```\npython3 ./scripts/bootstrap-template.py \u003cextension_name_you_want\u003e\n```\nFeel free to delete the script after this step.\n\nNow you're good to go! After a (re)build, you should now be able to use your duckdb extension:\n```\n./build/release/duckdb\nD select \u003cextension_name_you_chose\u003e('Jane') as result;\n┌─────────────────────────────────────┐\n│                result               │\n│               varchar               │\n├─────────────────────────────────────┤\n│ \u003cextension_name_you_chose\u003e Jane 🐥  │\n└─────────────────────────────────────┘\n```\n\nFor 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),\nthe [in-tree extensions](https://github.com/duckdb/duckdb/tree/main/extension), and the [out-of-tree extensions](https://github.com/duckdblabs).\n\n## Distributing your extension\nTo distribute your extension binaries, there are a few options.\n\n### Community extensions\nThe recommended way of distributing extensions is through the [community extensions repository](https://github.com/duckdb/community-extensions).\nThis repository is designed specifically for extensions that are built using this extension template, meaning that as long as your extension can be\nbuilt using the default CI in this template, submitting it to the community extensions is a very simple process. The process works similarly to popular\npackage managers like homebrew and vcpkg, where a PR containing a descriptor file is submitted to the package manager repository. After the CI in the\ncommunity extensions repository completes, the extension can be installed and loaded in DuckDB with:\n```SQL\nINSTALL \u003cmy_extension\u003e FROM community;\nLOAD \u003cmy_extension\u003e\n```\nFor more information, see the [community extensions documentation](https://duckdb.org/community_extensions/documentation).\n\n### Downloading artifacts from GitHub\nThe default CI in this template will automatically upload the binaries for every push to the main branch as GitHub Actions artifacts. These\ncan be downloaded manually and then loaded directly using:\n```SQL\nLOAD '/path/to/downloaded/extension.duckdb_extension';\n```\nNote that this will require starting DuckDB with the\n`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:\n```shell\nduckdb -unsigned\n```\n\n### Uploading to a custom repository\nIf for some reason distributing through community extensions is not an option, extensions can also be uploaded to a custom extension repository.\nThis will give some more control over where and how the extensions are distributed, but comes with the downside of requiring the `allow_unsigned_extensions`\noption 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.\nSome 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).\n\nExtensions in custom repositories can be installed and loaded using:\n```SQL\nINSTALL \u003cmy_extension\u003e FROM 'http://my-custom-repo'\nLOAD \u003cmy_extension\u003e\n```\n\n### Versioning of your extension\nExtension binaries will only work for the specific DuckDB version they were built for. The version of DuckDB that is targeted\nis set to the latest stable release for the main branch of the template so initially that is all you need. As new releases\nof DuckDB are published however, the extension repository will need to be updated. The template comes with a workflow set-up\nthat will automatically build the binaries for all DuckDB target architectures that are available in the corresponding DuckDB\nversion. This workflow is found in `.github/workflows/MainDistributionPipeline.yml`. It is up to the extension developer to keep\nthis up to date with DuckDB. Note also that its possible to distribute binaries for multiple DuckDB versions in this workflow\nby simply duplicating the jobs.\n\n## Setting up CLion\n\n### Opening project\nConfiguring CLion with the extension template requires a little work. Firstly, make sure that the DuckDB submodule is available.\nThen make sure to open `./duckdb/CMakeLists.txt` (so not the top level `CMakeLists.txt` file from this repo) as a project in CLion.\nNow to fix your project path go to `tools-\u003eCMake-\u003eChange 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.\n\n### Debugging\nTo set up debugging in CLion, there are two simple steps required. Firstly, in `CLion -\u003e Settings / Preferences -\u003e Build, Execution, Deploy -\u003e 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.\n\nThe second step is to configure the unittest runner as a run/debug configuration. To do this, go to `Run -\u003e Edit Configurations` and click `+ -\u003e 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.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquery-farm%2Fdiscreture","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquery-farm%2Fdiscreture","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquery-farm%2Fdiscreture/lists"}