-
Notifications
You must be signed in to change notification settings - Fork 518
[docs] Add C++ client documentation #2923
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
leekeiabstraction
merged 2 commits into
apache:main
from
Prajwal-banakar:docs-cpp-clients
Mar 30, 2026
+71
−1
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| --- | ||
| title: "Client Support Matrix" | ||
| sidebar_position: 4 | ||
| sidebar_position: 5 | ||
| --- | ||
|
|
||
| # Client Feature Support Matrix | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| --- | ||
| title: "C++ Client" | ||
| sidebar_position: 4 | ||
| --- | ||
|
|
||
| # Fluss C++ Client | ||
|
|
||
| The Fluss C++ Client provides a high-performance, synchronous interface for | ||
| interacting with Fluss clusters. It manages an internal Tokio runtime and | ||
| supports Apache Arrow for efficient data interchange. | ||
|
|
||
| The client provides two main APIs: | ||
|
|
||
| - **[Admin API](https://clients.fluss.apache.org/user-guide/cpp/api-reference#admin)**: For managing databases, tables, and partitions. | ||
| - **[Table API](https://clients.fluss.apache.org/user-guide/cpp/api-reference#table)**: For reading and writing to Log and Primary Key tables. | ||
|
|
||
| ## Installation | ||
|
|
||
| The C++ client is not yet published as a package and must be built from source. | ||
|
|
||
| **Prerequisites:** CMake 3.22+, C++17 compiler, Rust 1.85+, Apache Arrow C++ library | ||
|
|
||
| Install dependencies: | ||
| ```bash | ||
| # macOS | ||
| brew install cmake arrow | ||
|
|
||
| # Ubuntu/Debian | ||
| sudo apt-get install cmake libarrow-dev | ||
| ``` | ||
| ```bash | ||
| git clone https://github.com/apache/fluss-rust.git | ||
| cd fluss-rust/bindings/cpp | ||
| mkdir -p build && cd build | ||
| cmake -DCMAKE_BUILD_TYPE=Release .. | ||
| cmake --build . | ||
| ``` | ||
|
|
||
| For full build options including CMake integration into your own project, see the | ||
| [C++ client installation guide](https://clients.fluss.apache.org/user-guide/cpp/installation). | ||
|
|
||
| ## Quick Example | ||
| ```cpp | ||
| #include "fluss.hpp" | ||
|
|
||
| int main() { | ||
| fluss::Configuration config; | ||
| config.bootstrap_servers = "127.0.0.1:9123"; | ||
|
|
||
| fluss::Connection conn; | ||
| fluss::Result result = fluss::Connection::Create(config, conn); | ||
| if (!result.Ok()) { | ||
| std::cerr << "Connection failed: " << result.error_message << std::endl; | ||
| return 1; | ||
| } | ||
|
|
||
| fluss::Admin admin; | ||
| conn.GetAdmin(admin); | ||
|
|
||
| return 0; | ||
| } | ||
| ``` | ||
|
|
||
| For more examples, see the [Fluss C++ Client documentation](https://clients.fluss.apache.org/user-guide/cpp/example/). | ||
|
|
||
| ## Full Documentation | ||
|
|
||
| For the complete C++ client reference including all configuration options, | ||
| API methods, data types, error handling, and worked examples — see the | ||
| **[Fluss C++ Client documentation](https://clients.fluss.apache.org/user-guide/cpp/installation)**. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
C++ build from source is slightly more involved with dependencies installation needed as well. Can we either add steps to install those and / or link to main doc e.g. see also steps to install pre-requisites
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added the dependency installation steps for macOS and Ubuntu/Debian, and linked to the full installation guide for advanced options like CMake FetchContent integration. PTAL!