diff --git a/docs/Development.md b/docs/Development-Contributing.md similarity index 91% rename from docs/Development.md rename to docs/Development-Contributing.md index d3d026d51e3c..5053de76df1b 100644 --- a/docs/Development.md +++ b/docs/Development-Contributing.md @@ -22,11 +22,6 @@ ## Outline - -- How to develop IoTDB in IDE - - IDEA - - Eclipse - - Debugging IoTDB - Have Questions - Mailing Lists - JIRA issues @@ -46,40 +41,6 @@ - Code Style -# How to develop IoTDB in IDE - -There are many ways to compile the source code of IoTDB, -e.g., modify and compile with IDEA or Eclipse. - -Once all UTs are passed after you modify codes, your modification basically works! - -## IDEA - -* "File" -> "Open" -> choose the root path of IoTDB source code. -* mark directory ***iotdb/target/generated-sources/antlr3*** as source code -* mark directory ***service-rpc/target/generated-sources/thrift*** as source code - -## Eclipse - -Using Eclipse to develop IoTDB is also simple but requires some plugins of Eclipse. - -- If your Eclipse version is released before 2019, Antlr plugin maybe not work in Eclipse. In this way, you have to run the command in your console first: `mvn eclipse:eclipse -DskipTests`. -After the command is done, you can import IoTDB as an existing project: - - Choose menu "import" -> "General" -> "Existing Projects into Workspace" -> Choose IoTDB - root path; - - Done. - -- If your Eclipse version is fashion enough (e.g., you are using the latest version of Eclipse), -you can just choose menu "import" -> "Maven" -> "Existing Maven Projects". - -## Debugging IoTDB -The main class of IoTDB server is `org.apache.iotdb.db.service.IoTDB`. -The main class of IoTDB cli is `org.apache.iotdb.client.Client` -(or `org.apache.iotdb.client.WinClient` on Win OS). - -You can run/debug IoTDB by using the two classes as the entrance. - -Another way to understand IoTDB is to read and try Unit Tests. # Have Questions diff --git a/docs/Development-IDE.md b/docs/Development-IDE.md new file mode 100644 index 000000000000..1cc44fc4cbae --- /dev/null +++ b/docs/Development-IDE.md @@ -0,0 +1,65 @@ + + + + +## Outline +- How to develop IoTDB in IDE + - IDEA + - Eclipse + - Debugging IoTDB + + +# How to develop IoTDB in IDE + +There are many ways to compile the source code of IoTDB, +e.g., modify and compile with IDEA or Eclipse. + +Once all UTs are passed after you modify codes, your modification basically works! + +## IDEA + +* "File" -> "Open" -> choose the root path of IoTDB source code. +* use `mvn clean compile -Dmaven.test.skip=true`to get target. +* mark directory ***iotdb/target/generated-sources/antlr3*** as source code +* mark directory ***service-rpc/target/generated-sources/thrift*** as source code + +## Eclipse + +Using Eclipse to develop IoTDB is also simple but requires some plugins of Eclipse. + +- If your Eclipse version is released before 2019, Antlr plugin maybe not work in Eclipse. In this way, you have to run the command in your console first: `mvn eclipse:eclipse -DskipTests`. +After the command is done, you can import IoTDB as an existing project: + - Choose menu "import" -> "General" -> "Existing Projects into Workspace" -> Choose IoTDB + root path; + - Done. + +- If your Eclipse version is fashion enough (e.g., you are using the latest version of Eclipse), +you can just choose menu "import" -> "Maven" -> "Existing Maven Projects". + +## Debugging IoTDB +The main class of IoTDB server is `org.apache.iotdb.db.service.IoTDB`. +The main class of IoTDB cli is `org.apache.iotdb.client.Client` +(or `org.apache.iotdb.client.WinClient` on Win OS). + +You can run/debug IoTDB by using the two classes as the entrance. + +Another way to understand IoTDB is to read and try Unit Tests. diff --git a/service-rpc/rpc-changelist.md b/service-rpc/rpc-changelist.md index bc76116ff5ef..eff3f8d4f430 100644 --- a/service-rpc/rpc-changelist.md +++ b/service-rpc/rpc-changelist.md @@ -21,4 +21,14 @@ ## 0.8.0 (version-0) -> version-1 -* \ No newline at end of file +* Add Struct **TS_StatusType**, including code and message. Instead of using ~~TS_StatusCode~~, ~~errorCode~~ and ~~errorMessage~~, TS_Status use **TS_StatusType** to show specific success or error status, code and message. + +* Use struct **TSRPCResp** to replace all structs with only one field `1: required TS_Status status`, including: ~~TSCloseSessionResp~~ closeSession, ~~TSCancelOperationResp~~ cancelOperation, ~~TSCloseOperationResp~~ closeOperation, ~~TSSetTimeZoneResp~~ setTimeZone. + +* Add **TSBatchInsertionReq**, **TSCreateTimeseriesReq** and **TSSetStorageGroupReq**. + +* Change method name ~~TSExecuteStatementResp executeInsertion(1:TSInsertionReq req)~~ to **TSExecuteStatementResp insert(1:TSInsertionReq req)**, and add method **TSExecuteBatchStatementResp insertBatch(1:TSBatchInsertionReq req)** for batch inserting interface. + +* Add method **TSRPCResp setStorageGroup(1:TSSetStorageGroupReq req)** and **TSRPCResp createTimeseries(1:TSCreateTimeseriesReq req)** for creating matadata interface. + +* Change item in enum **TSProtocolVersion** from ~~TSFILE_SERVICE_PROTOCOL_V1~~ to IOTDB_SERVICE_PROTOCOL_V1.