substrait-cpp

Planned home for CPP libraries to help build/consume Substrait query plans.

Getting Started

We provide scripts to help developers setup and install substrait-cpp dependencies.

Get the substrait-cpp Source

git clone --recursive https://github.com/substrait-io/substrait-cpp.git
cd substrait-cpp
# if you are updating an existing checkout
git submodule sync --recursive
git submodule update --init --recursive

Setting up on Linux (Ubuntu 20.04 or later)

Once you have checked out substrait-cpp, you can set up and build like so:

$ ./scripts/setup-ubuntu.sh 
$ make

Coding style

Basically the coding style is based on Google C++ Style, but there are some naming style changed:

• Function case style change to 'camelBack'
• Variable case style change to 'camelBack'
• Class Member case style change to 'camelBack' with '_' as suffix

For more detail information please refer to .clang-tidy.

You can run make format script to formatting source code. To enable clang-tidy checks during compilation, use the options from cmake/clang-tidy.cmake. To apply the suggested fixes, run the following command in the root directory:

clang-apply-replacements-22 --ignore-insert-conflict build/clang-tidy-fixes/

License

substrait-cpp is licensed under the Apache 2.0 License. A copy of the license can be found here.