You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@fluss.apache.org by "Prajwal-banakar (via GitHub)" <gi...@apache.org> on 2026/03/24 13:51:38 UTC

[PR] [docs] Add C++ client documentation [fluss]

Prajwal-banakar opened a new pull request, #2923:
URL: https://github.com/apache/fluss/pull/2923

   <!--
   *Thank you very much for contributing to Fluss - we are happy that you want to help us improve Fluss. To help the community review your contribution in the best possible way, please go through the checklist below, which will get the contribution into a shape in which it can be best reviewed.*
   
   ## Contribution Checklist
   
     - Make sure that the pull request corresponds to a [GitHub issue](https://github.com/apache/fluss/issues). Exceptions are made for typos in JavaDoc or documentation files, which need no issue.
   
     - Name the pull request in the format "[component] Title of the pull request", where *[component]* should be replaced by the name of the component being changed. Typically, this corresponds to the component label assigned to the issue (e.g., [kv], [log], [client], [flink]). Skip *[component]* if you are unsure about which is the best component.
   
     - Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
   
     - Make sure that the change passes the automated tests, i.e., `mvn clean verify` passes.
   
     - Each pull request should address only one issue, not mix up code from multiple issues.
   
   
   **(The sections below can be removed for hotfixes or typos)**
   -->
   
   ### Purpose
   
   <!-- Linking this pull request to the issue -->
   Linked issue: close #2448
   
   <!-- What is the purpose of the change -->
   This PR adds a lightweight documentation page for the Fluss C++ Client, following the same pattern as the recently merged Rust (#2462) and Python (#2461) client documentation PRs.
   
   ### Brief change log
   
   <!-- Please describe the changes made in this pull request and explain how they address the issue -->
   - Created website/docs/apis/cpp-client.md with an overview, installation steps, a quick example, and a link to the full reference at https://clients.fluss.apache.org/user-guide/cpp/installation
   - Updated client-support-matrix.md sidebar position to 5 to accommodate the new page at position 4
   ### Tests
   
   <!-- List UT and IT cases to verify this change -->
   Manual verification using the Docusaurus development server page renders correctly and appears in the correct sidebar position.
   <img width="1920" height="1080" alt="image" src="https://github.com/user-attachments/assets/71871af7-6bc4-48ae-824a-85a57ff7e011" />
   
   ### API and Format
   
   <!-- Does this change affect API or storage format -->
   Documentation only. No API or storage format changes.
   ### Documentation
   
   <!-- Does this change introduce a new feature -->
   Adds new page for  C++ client


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@fluss.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [docs] Add C++ client documentation [fluss]

Posted by "leekeiabstraction (via GitHub)" <gi...@apache.org>.
leekeiabstraction merged PR #2923:
URL: https://github.com/apache/fluss/pull/2923


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@fluss.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [docs] Add C++ client documentation [fluss]

Posted by "leekeiabstraction (via GitHub)" <gi...@apache.org>.
leekeiabstraction commented on code in PR #2923:
URL: https://github.com/apache/fluss/pull/2923#discussion_r3005251716


##########
website/docs/apis/cpp-client.md:
##########
@@ -0,0 +1,58 @@
+---
+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

Review Comment:
   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](https://clients.fluss.apache.org/user-guide/cpp/installation/)



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@fluss.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [docs] Add C++ client documentation [fluss]

Posted by "Prajwal-banakar (via GitHub)" <gi...@apache.org>.
Prajwal-banakar commented on code in PR #2923:
URL: https://github.com/apache/fluss/pull/2923#discussion_r3006240498


##########
website/docs/apis/cpp-client.md:
##########
@@ -0,0 +1,58 @@
+---
+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

Review Comment:
   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!



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@fluss.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org