You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by ha...@apache.org on 2022/11/02 09:13:30 UTC
[iotdb] branch master updated: Complete document of Data Write chapter and add ways of loading (#7876)
This is an automated email from the ASF dual-hosted git repository.
haonan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new 71c55e9abd Complete document of Data Write chapter and add ways of loading (#7876)
71c55e9abd is described below
commit 71c55e9abd35d4238b54bf232c17fb02e0ab66ca
Author: wanghui42 <10...@users.noreply.github.com>
AuthorDate: Wed Nov 2 17:13:24 2022 +0800
Complete document of Data Write chapter and add ways of loading (#7876)
---
docs/UserGuide/Write-Data/MQTT.md | 24 +++++++++++++++++++++
docs/UserGuide/Write-Data/REST-API.md | 24 +++++++++++++++++++++
docs/UserGuide/Write-Data/Session.md | 37 ++++++++++++++++++++++++++++++++
docs/zh/UserGuide/Write-Data/MQTT.md | 24 +++++++++++++++++++++
docs/zh/UserGuide/Write-Data/REST-API.md | 24 +++++++++++++++++++++
docs/zh/UserGuide/Write-Data/Session.md | 37 ++++++++++++++++++++++++++++++++
site/src/main/.vuepress/config.js | 14 ++++++++----
7 files changed, 180 insertions(+), 4 deletions(-)
diff --git a/docs/UserGuide/Write-Data/MQTT.md b/docs/UserGuide/Write-Data/MQTT.md
new file mode 100644
index 0000000000..492e2e1919
--- /dev/null
+++ b/docs/UserGuide/Write-Data/MQTT.md
@@ -0,0 +1,24 @@
+<!--
+
+ 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.
+
+-->
+
+# MQTT Write
+
+Refer to [Built-in MQTT Service](../API/Programming-MQTT.md#built-in-mqtt-service)
\ No newline at end of file
diff --git a/docs/UserGuide/Write-Data/REST-API.md b/docs/UserGuide/Write-Data/REST-API.md
new file mode 100644
index 0000000000..2014e7ace7
--- /dev/null
+++ b/docs/UserGuide/Write-Data/REST-API.md
@@ -0,0 +1,24 @@
+<!--
+
+ 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.
+
+-->
+
+# REST API Write
+
+Refer to [insertTablet](../API/RestService.md#inserttablet)
\ No newline at end of file
diff --git a/docs/UserGuide/Write-Data/Session.md b/docs/UserGuide/Write-Data/Session.md
new file mode 100644
index 0000000000..c3c0ec5400
--- /dev/null
+++ b/docs/UserGuide/Write-Data/Session.md
@@ -0,0 +1,37 @@
+<!--
+
+ 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.
+
+-->
+
+# Native API Write
+The Native API ( Session ) is the most widely used series of APIs of IoTDB, including multiple APIs, adapted to different data collection scenarios, with high performance and multi-language support.
+
+## Multi-language API write
+* ### Java
+ Before writing via the Java API, you need to establish a connection, refer to [Java Native API](../API/Programming-Java-Native-API.md).
+ then refer to [ JAVA Data Manipulation Interface (DML) ](../API/Programming-Java-Native-API.md#insert)
+
+* ### Python
+ Refer to [ Python Data Manipulation Interface (DML) ](../API/Programming-Python-Native-API.md#insert)
+
+* ### C++
+ Refer to [ C++ Data Manipulation Interface (DML) ](../API/Programming-Cpp-Native-API.md#insert)
+
+* ### Go
+ Refer to [Go Native API](../API/Programming-Go-Native-API.md)
\ No newline at end of file
diff --git a/docs/zh/UserGuide/Write-Data/MQTT.md b/docs/zh/UserGuide/Write-Data/MQTT.md
new file mode 100644
index 0000000000..59af6e6a21
--- /dev/null
+++ b/docs/zh/UserGuide/Write-Data/MQTT.md
@@ -0,0 +1,24 @@
+<!--
+
+ 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.
+
+-->
+
+# MQTT写入
+
+参考 [内置 MQTT 服务](../API/Programming-MQTT.md#内置-mqtt-服务)
\ No newline at end of file
diff --git a/docs/zh/UserGuide/Write-Data/REST-API.md b/docs/zh/UserGuide/Write-Data/REST-API.md
new file mode 100644
index 0000000000..e77b35f9e0
--- /dev/null
+++ b/docs/zh/UserGuide/Write-Data/REST-API.md
@@ -0,0 +1,24 @@
+<!--
+
+ 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.
+
+-->
+
+# REST API写入
+
+参考 [insertTablet](../API/RestService.md#inserttablet)
\ No newline at end of file
diff --git a/docs/zh/UserGuide/Write-Data/Session.md b/docs/zh/UserGuide/Write-Data/Session.md
new file mode 100644
index 0000000000..693127d88a
--- /dev/null
+++ b/docs/zh/UserGuide/Write-Data/Session.md
@@ -0,0 +1,37 @@
+<!--
+
+ 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.
+
+-->
+
+# 原生接口写入
+原生接口 （Session） 是目前IoTDB使用最广泛的系列接口，包含多种写入接口，适配不同的数据采集场景，性能高效且支持多语言。
+
+## 多语言接口写入
+* ### Java
+ 使用Java接口写入之前，你需要先建立连接，参考 [Java原生接口](../API/Programming-Java-Native-API.md)。
+ 之后通过 [ JAVA 数据操作接口（DML）](../API/Programming-Java-Native-API.md#数据写入)写入。
+
+* ### Python
+ 参考 [ Python 数据操作接口（DML）](../API/Programming-Python-Native-API.md#数据写入)
+
+* ### C++
+ 参考 [ C++ 数据操作接口（DML）](../API/Programming-Cpp-Native-API.md)
+
+* ### Go
+ 参考 [Go 原生接口](../API/Programming-Go-Native-API.md)
\ No newline at end of file
diff --git a/site/src/main/.vuepress/config.js b/site/src/main/.vuepress/config.js
index acebd98e00..9b4bb287db 100644
--- a/site/src/main/.vuepress/config.js
+++ b/site/src/main/.vuepress/config.js
@@ -894,10 +894,13 @@ var config = {
]
},
{
- title: 'Write Data',
+ title: 'Write Data (Update Data)',
sidebarDepth: 1,
children: [
- ['Write-Data/Write-Data','Write Data'],
+ ['Write-Data/Write-Data','CLI Write'],
+ ['Write-Data/Session','Native API Write'],
+ ['Write-Data/REST-API','REST API'],
+ ['Write-Data/MQTT','MQTT Write'],
['Write-Data/Load-External-Tsfile','Load External Tsfile'],
['Write-Data/CSV-Tool','CSV Tool'],
]
@@ -1828,10 +1831,13 @@ var config = {
]
},
{
- title: '数据写入',
+ title: '数据写入（更新）',
sidebarDepth: 1,
children: [
- ['Write-Data/Write-Data','写入数据'],
+ ['Write-Data/Write-Data','CLI 工具写入'],
+ ['Write-Data/Session','原生接口写入'],
+ ['Write-Data/REST-API','REST 服务'],
+ ['Write-Data/MQTT','MQTT写入'],
['Write-Data/Load-External-Tsfile','加载 TsFile'],
['Write-Data/CSV-Tool','导入导出 CSV']
]