Skip to content

Commit 853596b

Browse files
committed
Doc: add dependency setup instructions for PAX
- Added detailed dependency requirements for building PAX, including GCC, CMake, Protobuf, ZSTD, and optional glib-2.0 for vectorization. - Included instructions for initializing submodules required for building and testing PAX. These updates aim to improve clarity for developers setting up the PAX build environment.
1 parent 4413337 commit 853596b

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

contrib/pax_storage/doc/README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,25 @@ PAX has the following features:
2121

2222
### Build PAX
2323

24-
PAX will be built with `--enable-pax` when users building the Cloudberry.
24+
PAX will be built with `--enable-pax` when you build the Cloudberry. Dependency requirements are as follows:
25+
26+
- **C/C++ Compiler**: GCC/GCC-C++ 11 or later
27+
- **CMake**: 3.11 or later
28+
- **Protobuf**: 3.5.0 or later
29+
- **ZSTD (libzstd)**: 1.4.0 or later
30+
31+
Also, you need to run the following command at the top level of the Cloudberry source code directory to download the submodules:
32+
33+
```
34+
git submodule update --init --recursive
35+
```
36+
37+
The following submodules will be downloaded for building and tesing PAX:
38+
- yyjson (`dependency/yyjson`)
39+
- cpp-stub (`contrib/pax_storage/src/cpp/cotnrib`)
40+
- googlebench (`contrib/pax_storage/src/cpp/cotnrib`)
41+
- googletest (`contrib/pax_storage/src/cpp/cotnrib`)
42+
- tabulate (`contrib/pax_storage/src/cpp/cotnrib`)
2543

2644
### Build debug version
2745

0 commit comments

Comments
 (0)