[GitHub] [incubator-iotdb] qiaojialin commented on a change in pull request #1218: [IoTDB-682]Add client-cpp and update docs/UserGuide/3-Server/1-Download.md

[GitBox <gi...@apache.org>]

qiaojialin commented on a change in pull request #1218:
URL: https://github.com/apache/incubator-iotdb/pull/1218#discussion_r426252147



##########
File path: client-cpp/README.md
##########
@@ -0,0 +1,40 @@
+# client-cpp
+Client in language C++ for Apache IoTDB using CMake on Linux
+
+# 0. Apache IoTDB:
+* [Apache IoTDB website](http://iotdb.apache.org/)
+
+* [Apache IoTDB github](https://github.com/apache/incubator-iotdb)
+
+# 1. Description of client-cpp structure
+* `SessionExample.cpp` : the main function of the project, containing examples of the client methods to use IoTDB 
+* `compile.sh` : The script to compile the client automatically.
+* `Session` (folder) : Class Session which wrap the rpc interfaces generated by thrift
+* `CMakeLists.txt` (the one under project root directory) : the CMakeLists for the whole project
+* `build` (folder) : The files generated by cmake while compiling and after compiled. Before compiling, this folder is empty.
+* `libthrift.a, libthriftnb.a` : thrift cpp static library
+
+# 2. How to run
+Under the project root directory, run commands:
+```
+./chmod u+x compile.sh
+
+./compile.sh
+
+./client-cpp
+```
+
+# 3. Prerequisites
+* thrift version: 0.13.0 : you need to build and install thrift out of the source repository, just refer to this website:[Building Thrift from source](https://thrift.apache.org/docs/BuildingFromSource). You may note that after this by default the thrift C++ library(both static and dynamic) is built already, you can find them in the lib/cpp/.lib folder.
+* cmake version: 3.16 : [CMake Download](https://cmake.org/download/)

Review comment:
       put this in front of "How to run"

##########
File path: client-cpp/README.md
##########
@@ -0,0 +1,40 @@
+# client-cpp
+Client in language C++ for Apache IoTDB using CMake on Linux
+
+# 0. Apache IoTDB:
+* [Apache IoTDB website](http://iotdb.apache.org/)
+
+* [Apache IoTDB github](https://github.com/apache/incubator-iotdb)

Review comment:
       no need to add this, we are already in iotdb repo

##########
File path: client-cpp/rpc.thrift
##########
@@ -0,0 +1,310 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+namespace java org.apache.iotdb.service.rpc.thrift

Review comment:
       Do not copy this file, use the service-rpc/src/main/thrift/rpc.thrift




----------------------------------------------------------------
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.

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