fix(client-cpp): PR review follow-ups for SDK branch

hongzhi-gao · hongzhi-gao · commit 0b97892deb99 · 2026-05-26T17:00:14.000+08:00
Guard checkTemplateExists against a null dataset, document DataIterator lifetime, correct README Maven vs CMake option names, drop unused IotdbResolveTarball.cmake, and skip server CI when only multi-language-client workflow changes.
diff --git a/.github/workflows/cluster-it-1c1d.yml b/.github/workflows/cluster-it-1c1d.yml
@@ -14,6 +14,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
   pull_request:
     branches:
       - master
@@ -27,6 +28,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
   # allow manually run the action:
   workflow_dispatch:
 
diff --git a/.github/workflows/cluster-it-1c1d1a.yml b/.github/workflows/cluster-it-1c1d1a.yml
@@ -14,6 +14,7 @@ on:
       - '.github/workflows/client-cpp-package.yml'
       - '.github/workflows/client-cpp-source-build.yml'
       - '.github/scripts/package-client-cpp-*.sh'
+      - '.github/workflows/multi-language-client.yml'
   pull_request:
     branches:
       - master
@@ -28,6 +29,7 @@ on:
       - '.github/workflows/client-cpp-package.yml'
       - '.github/workflows/client-cpp-source-build.yml'
       - '.github/scripts/package-client-cpp-*.sh'
+      - '.github/workflows/multi-language-client.yml'
   # allow manually run the action:
   workflow_dispatch:
 
diff --git a/.github/workflows/cluster-it-1c3d.yml b/.github/workflows/cluster-it-1c3d.yml
@@ -14,6 +14,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
   pull_request:
     branches:
       - master
@@ -28,6 +29,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
   # allow manually run the action:
   workflow_dispatch:
 
diff --git a/.github/workflows/compile-check.yml b/.github/workflows/compile-check.yml
@@ -16,6 +16,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
   pull_request:
     branches:
       - master
@@ -30,6 +31,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
   # allow manually run the action:
   workflow_dispatch:
 
diff --git a/.github/workflows/dependency-check.yml b/.github/workflows/dependency-check.yml
@@ -16,6 +16,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
   pull_request:
     branches:
       - master
@@ -30,6 +31,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
   # allow manually run the action:
   workflow_dispatch:
 
diff --git a/.github/workflows/pipe-it.yml b/.github/workflows/pipe-it.yml
@@ -14,6 +14,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
       - "iotdb-core/datanode/src/main/java/org/apache/iotdb/db/queryengine/**" #queryengine
   pull_request:
     branches:
@@ -29,6 +30,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
       - "iotdb-core/datanode/src/main/java/org/apache/iotdb/db/queryengine/**" #queryengine
   # allow manually run the action:
   workflow_dispatch:
diff --git a/.github/workflows/sonar-codecov.yml b/.github/workflows/sonar-codecov.yml
@@ -17,6 +17,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
   pull_request:
     branches:
       - master
@@ -32,6 +33,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
   # allow manually run the action:
   workflow_dispatch:
 
diff --git a/.github/workflows/table-cluster-it-1c1d.yml b/.github/workflows/table-cluster-it-1c1d.yml
@@ -14,6 +14,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
   pull_request:
     branches:
       - master
@@ -28,6 +29,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
   # allow manually run the action:
   workflow_dispatch:
 
diff --git a/.github/workflows/table-cluster-it-1c3d.yml b/.github/workflows/table-cluster-it-1c3d.yml
@@ -14,6 +14,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
   pull_request:
     branches:
       - master
@@ -28,6 +29,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
   # allow manually run the action:
   workflow_dispatch:
 
diff --git a/.github/workflows/unit-test.yml b/.github/workflows/unit-test.yml
@@ -17,6 +17,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
   pull_request:
     branches:
       - master
@@ -31,6 +32,7 @@ on:
       - ".github/workflows/client-cpp-package.yml"
       - ".github/workflows/client-cpp-source-build.yml"
       - ".github/scripts/package-client-cpp-*.sh"
+      - ".github/workflows/multi-language-client.yml"
   # allow manually run the action:
   workflow_dispatch:
 
diff --git a/iotdb-client/client-cpp/README.md b/iotdb-client/client-cpp/README.md
@@ -127,12 +127,22 @@ mvn -P with-cpp -pl iotdb-client/client-cpp -am -DskipTests `
 
 On Windows, the build passes `-DCMAKE_GENERATOR_PLATFORM=x64` so Visual Studio
 generators target **x64** (VS2017 otherwise defaults to Win32).
-```
 
 ## CMake options
 
-All of these can be set on the Maven command line (`-DWITH_SSL=ON`, etc.) or
-passed directly to `cmake`.
+The table below lists CMake cache variables. When building through **Maven**,
+pass them as Maven properties (the POM maps them to `-D` options for CMake):
+
+| CMake variable | Maven property (`-D...`) |
+|----------------|--------------------------|
+| `WITH_SSL` | `with.ssl` (e.g. `-Dwith.ssl=ON`) |
+| `IOTDB_OFFLINE` | `iotdb.offline` |
+| `BUILD_TESTING` | `build.tests` |
+| `IOTDB_DEPS_DIR` | `iotdb.deps.dir` |
+| `BOOST_INCLUDEDIR` | `boost.include.dir` (legacy alias) |
+
+For a **standalone** `cmake` configure, pass `-DWITH_SSL=ON`, `-DIOTDB_OFFLINE=ON`,
+etc. directly.
 
 | Option                | Default                          | Purpose                                                                                                  |
 |-----------------------|----------------------------------|----------------------------------------------------------------------------------------------------------|
@@ -178,11 +188,11 @@ mvn -P with-cpp -pl iotdb-client/client-cpp -am -DskipTests "-Dboost.include.dir
    - GNU bison 3.8:       <https://ftp.gnu.org/gnu/bison/bison-3.8.tar.gz>
    - OpenSSL 3.5.0:       <https://www.openssl.org/source/openssl-3.5.0.tar.gz>
 
-2. Run the build with `-DIOTDB_OFFLINE=ON`:
+2. Run the build with offline mode enabled:
 
    ```bash
    mvn -P with-cpp -pl iotdb-client/client-cpp -am -DskipTests \
-       -DIOTDB_OFFLINE=ON package
+       -Diotdb.offline=ON package
    ```
 
    or, going straight through CMake:
@@ -247,7 +257,8 @@ the GNU autotools tarballs assume a POSIX shell environment.
 ## SSL
 
 Both Thrift and `iotdb_session` build without OpenSSL by default. Enable
-SSL support with `-DWITH_SSL=ON`. CMake first calls `find_package(OpenSSL)`;
+SSL with `-Dwith.ssl=ON` (Maven) or `-DWITH_SSL=ON` (standalone CMake).
+CMake first calls `find_package(OpenSSL)`;
 if nothing is found, it falls back to:
 
 - **Linux / macOS** – use a local `openssl-<ver>.tar.gz` (or download it
diff --git a/iotdb-client/client-cpp/cmake/IotdbResolveTarball.cmake b/iotdb-client/client-cpp/cmake/IotdbResolveTarball.cmake
diff --git a/iotdb-client/client-cpp/src/include/SessionDataSet.h b/iotdb-client/client-cpp/src/include/SessionDataSet.h
@@ -117,6 +117,7 @@ class SessionDataSet {
     const std::vector<std::string>& getColumnTypeList() const;
   };
 
+  // The returned iterator must not outlive this SessionDataSet.
   DataIterator getIterator();
 };
 
diff --git a/iotdb-client/client-cpp/src/session/Session.cpp b/iotdb-client/client-cpp/src/session/Session.cpp
@@ -2330,6 +2330,9 @@ bool Session::checkTemplateExists(const string& template_name) {
   try {
     std::unique_ptr<SessionDataSet> dataset =
         executeQueryStatement("SHOW NODES IN DEVICE TEMPLATE " + template_name);
+    if (dataset == nullptr) {
+      throw IoTDBException("executeQueryStatement failed");
+    }
     bool isExisted = dataset->hasNext();
     dataset->closeOperationHandle();
     return isExisted;
