![](https://private-user-images.githubusercontent.com/1423657/346273832-144dc202-f88a-4a2b-903d-51e30be75f6a.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjQ4NjAyMDQsIm5iZiI6MTcyNDg1OTkwNCwicGF0aCI6Ii8xNDIzNjU3LzM0NjI3MzgzMi0xNDRkYzIwMi1mODhhLTRhMmItOTAzZC01MWUzMGJlNzVmNmEucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDgyOCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA4MjhUMTU0NTA0WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ZmFjYjNiZmVjMzY4OTJjNTM2ZjVhY2UwNzFiYTllMTIwOTE1NGYzMTZlYjhmOWIxYzdhZTgzYjM1YTdmYjI4NCZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.R8N274SqOoFIs37unIcazGhm2YdwT_CTkpxUgJ2oyq0)
The chsql DuckDB extension implements various macros using ClickHouse SQL syntax, making it easier
to transition between the two database systems ⭐ designed for Quackpipe
chsql is distributed as a DuckDB Community Extension and can be installed using SQL:
INSTALL chsql FROM community;
LOAD chsql;
If you previously installed the chsql
extension, upgrade using the FORCE command
FORCE INSTALL chsql FROM community;
LOAD chsql;
The list of supported functions is available on the dedicated extension page.
Once installed, macro functions provided by the extension can be used just like built-in functions.
D INSTALL chsql FROM community;
D LOAD chsql;
D SELECT IPv4StringToNum('127.0.0.1'), IPv4NumToString(2130706433);
┌──────────────────────────────┬─────────────────────────────┐
│ ipv4stringtonum('127.0.0.1') │ ipv4numtostring(2130706433) │
│ int32 │ varchar │
├──────────────────────────────┼─────────────────────────────┤
│ 2130706433 │ 127.0.0.1 │
└──────────────────────────────┴─────────────────────────────┘
The extension is automatically build and distributed. This section is not required unless you are a developer extending the code.
DuckDB extensions uses VCPKG for dependency management. Enabling VCPKG is very simple: follow the installation instructions or just run the following:
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.
Clone the repository and fetch all required submodules:
git submodule update --init
Build the extension:
GEN=ninja make
The main binaries that will be built are:
./build/release/duckdb
./build/release/test/unittest
./build/release/extension/dynamic_sql_clickhouse/dynamic_sql_clickhouse.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.dynamic_sql_clickhouse.duckdb_extension
is the loadable binary as it would be distributed.
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. See /tests/sql
for a list of supported functions.
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:
make test