This is an automated email from the ASF dual-hosted git repository.
colinlee pushed a commit to branch add_doc
in repository https://gitbox.apache.org/repos/asf/tsfile.git
The following commit(s) were added to refs/heads/add_doc by this push:
new c05032f5 update user guide.
c05032f5 is described below
commit c05032f500f7ee81d2a8b59ed18a658a5d0aeae5
Author: ColinLee <[email protected]>
AuthorDate: Mon Nov 3 10:19:00 2025 +0800
update user guide.
---
.../develop/QuickStart/QuickStart-JAVA.md | 13 +-------
.../develop/QuickStart/QuickStart-PYTHON.md | 27 ++++++++++++++++-
.../latest/QuickStart/QuickStart-PYTHON.md | 28 ++++++++++++++++-
src/UserGuide/latest/QuickStart/QuickStart.md | 13 +-------
.../develop/QuickStart/QuickStart-JAVA.md | 13 +-------
.../develop/QuickStart/QuickStart-PYTHON.md | 35 +++++++++++++++++-----
.../latest/QuickStart/QuickStart-PYTHON.md | 35 +++++++++++++++++-----
src/zh/UserGuide/latest/QuickStart/QuickStart.md | 13 +-------
8 files changed, 111 insertions(+), 66 deletions(-)
diff --git a/src/UserGuide/develop/QuickStart/QuickStart-JAVA.md
b/src/UserGuide/develop/QuickStart/QuickStart-JAVA.md
index 5ac101ad..2d329a13 100644
--- a/src/UserGuide/develop/QuickStart/QuickStart-JAVA.md
+++ b/src/UserGuide/develop/QuickStart/QuickStart-JAVA.md
@@ -27,24 +27,13 @@
## Installation Method
-Clone the source code from git:
-
-```shell
-git clone https://github.com/apache/tsfile.git
-```
-Run Maven to compile in the TsFile root directory:
-
-```shell
-mvn clean install -P with-java -DskipTests
-```
-
Using TsFile API with Maven:
```shell
<dependency>
<groupId>org.apache.tsfile</groupId>
<artifactId>tsfile</artifactId>
- <version>2.0.1</version>
+ <version>2.1.1</version>
</dependency>
```
diff --git a/src/UserGuide/develop/QuickStart/QuickStart-PYTHON.md
b/src/UserGuide/develop/QuickStart/QuickStart-PYTHON.md
index 2f2cb2b0..5ede2462 100644
--- a/src/UserGuide/develop/QuickStart/QuickStart-PYTHON.md
+++ b/src/UserGuide/develop/QuickStart/QuickStart-PYTHON.md
@@ -40,6 +40,26 @@ pandas >= 2.2.2
## Installation Method
+### Install From Pypi
+
+use pip to install the latest version from pypi:
+
+```shell
+pip install tsfile
+```
+Platform support:
+
+| Platform | python |
+| ------------- | -------------------------------- |
+| Linux_x86_64 | py39, py310, py311, py312, py313 |
+| Linux_aarch64 | py39, py310, py311, py312, py313 |
+| MacOS_arm64 | py39, py310, py311, py312, py313 |
+| MacOS_X86_64 | py39, py310, py311, py312, py313 |
+| Win_amd64 | py39, py310, py311, py312, py313 |
+
+To download wheel from pypi: https://pypi.org/project/tsfile/#files
+
+
### Compile on your local envirment
Clone the source code from git:
@@ -76,10 +96,12 @@ pip install tsfile.wheel
```
-
## Writing Process
```Python
+import os
+from tsfile import *
+
table_data_dir = os.path.join(os.path.dirname(__file__), "table_data.tsfile")
if os.path.exists(table_data_dir):
os.remove(table_data_dir)
@@ -110,6 +132,9 @@ with TsFileTableWriter(table_data_dir, table_schema) as
writer:
## Reading Process
```Python
+import os
+from tsfile import *
+
table_data_dir = os.path.join(os.path.dirname(__file__), "table_data.tsfile")
### Free resource automatically
with TsFileReader(table_data_dir) as reader:
diff --git a/src/UserGuide/latest/QuickStart/QuickStart-PYTHON.md
b/src/UserGuide/latest/QuickStart/QuickStart-PYTHON.md
index 2f2cb2b0..3e5166c6 100644
--- a/src/UserGuide/latest/QuickStart/QuickStart-PYTHON.md
+++ b/src/UserGuide/latest/QuickStart/QuickStart-PYTHON.md
@@ -40,6 +40,27 @@ pandas >= 2.2.2
## Installation Method
+### Install From Pypi
+
+use pip to install the latest version from pypi:
+
+```shell
+pip install tsfile
+```
+Platform support:
+
+| Platform | python |
+| ------------- | -------------------------------- |
+| Linux_x86_64 | py39, py310, py311, py312, py313 |
+| Linux_aarch64 | py39, py310, py311, py312, py313 |
+| MacOS_arm64 | py39, py310, py311, py312, py313 |
+| MacOS_X86_64 | py39, py310, py311, py312, py313 |
+| Win_amd64 | py39, py310, py311, py312, py313 |
+
+To download wheel from pypi: https://pypi.org/project/tsfile/#files
+
+
+
### Compile on your local envirment
Clone the source code from git:
@@ -76,10 +97,12 @@ pip install tsfile.wheel
```
-
## Writing Process
```Python
+import os
+from tsfile import *
+
table_data_dir = os.path.join(os.path.dirname(__file__), "table_data.tsfile")
if os.path.exists(table_data_dir):
os.remove(table_data_dir)
@@ -110,6 +133,9 @@ with TsFileTableWriter(table_data_dir, table_schema) as
writer:
## Reading Process
```Python
+import os
+from tsfile import *
+
table_data_dir = os.path.join(os.path.dirname(__file__), "table_data.tsfile")
### Free resource automatically
with TsFileReader(table_data_dir) as reader:
diff --git a/src/UserGuide/latest/QuickStart/QuickStart.md
b/src/UserGuide/latest/QuickStart/QuickStart.md
index 5ac101ad..2d329a13 100644
--- a/src/UserGuide/latest/QuickStart/QuickStart.md
+++ b/src/UserGuide/latest/QuickStart/QuickStart.md
@@ -27,24 +27,13 @@
## Installation Method
-Clone the source code from git:
-
-```shell
-git clone https://github.com/apache/tsfile.git
-```
-Run Maven to compile in the TsFile root directory:
-
-```shell
-mvn clean install -P with-java -DskipTests
-```
-
Using TsFile API with Maven:
```shell
<dependency>
<groupId>org.apache.tsfile</groupId>
<artifactId>tsfile</artifactId>
- <version>2.0.1</version>
+ <version>2.1.1</version>
</dependency>
```
diff --git a/src/zh/UserGuide/develop/QuickStart/QuickStart-JAVA.md
b/src/zh/UserGuide/develop/QuickStart/QuickStart-JAVA.md
index b0c195f0..597ab831 100644
--- a/src/zh/UserGuide/develop/QuickStart/QuickStart-JAVA.md
+++ b/src/zh/UserGuide/develop/QuickStart/QuickStart-JAVA.md
@@ -27,24 +27,13 @@
## 安装
-从git克隆源代码:
-
-```shell
-git clone https://github.com/apache/tsfile.git
-```
-在 TsFile 根目录下执行 maven 编译:
-
-```shell
-mvn clean install -P with-java -DskipTests
-```
-
在 Maven 中引用 TsFile API:
```shell
<dependency>
<groupId>org.apache.tsfile</groupId>
<artifactId>tsfile</artifactId>
- <version>2.0.1</version>
+ <version>2.1.1</version>
</dependency>
```
diff --git a/src/zh/UserGuide/develop/QuickStart/QuickStart-PYTHON.md
b/src/zh/UserGuide/develop/QuickStart/QuickStart-PYTHON.md
index 6978bede..bd147ffd 100644
--- a/src/zh/UserGuide/develop/QuickStart/QuickStart-PYTHON.md
+++ b/src/zh/UserGuide/develop/QuickStart/QuickStart-PYTHON.md
@@ -40,6 +40,27 @@ pandas >= 2.2.2
## 安装
+### 使用 PIP 进行在线安装
+
+使用pip 指令来在线安装 TsFile 包
+
+```bash
+pip install tsfile
+```
+
+支持的架构平台如下：
+
+| Platform | python |
+| ------------- | -------------------------------- |
+| Linux_x86_64 | py39, py310, py311, py312, py313 |
+| Linus_aarch64 | py39, py310, py311, py312, py313 |
+| MacOS_arm64 | py39, py310, py311, py312, py313 |
+| MacOS_X86_64 | py39, py310, py311, py312, py313 |
+| Win_amd64 | py39, py310, py311, py312, py313 |
+
+或者直接下载 wheel 文件安装：https://pypi.org/project/tsfile/#files
+
+
### 在本地进行编译
从git克隆源代码:
@@ -76,18 +97,13 @@ mvnw.cmd clean install -P with-python -DskipTests
pip install tsfile.wheel
```
-### 使用 PIP 进行在线安装
-
-使用pip 指令来在线安装 TsFile 包
-
-```bash
-pip install tsfile
-```
-
## 写入示例
```Python
+import os
+from tsfile import *
+
table_data_dir = os.path.join(os.path.dirname(__file__), "table_data.tsfile")
if os.path.exists(table_data_dir):
os.remove(table_data_dir)
@@ -118,6 +134,9 @@ with TsFileTableWriter(table_data_dir, table_schema) as
writer:
## 读取示例
```Python
+import os
+from tsfile import *
+
table_data_dir = os.path.join(os.path.dirname(__file__), "table_data.tsfile")
### Free resource automatically
with TsFileReader(table_data_dir) as reader:
diff --git a/src/zh/UserGuide/latest/QuickStart/QuickStart-PYTHON.md
b/src/zh/UserGuide/latest/QuickStart/QuickStart-PYTHON.md
index 6978bede..bd147ffd 100644
--- a/src/zh/UserGuide/latest/QuickStart/QuickStart-PYTHON.md
+++ b/src/zh/UserGuide/latest/QuickStart/QuickStart-PYTHON.md
@@ -40,6 +40,27 @@ pandas >= 2.2.2
## 安装
+### 使用 PIP 进行在线安装
+
+使用pip 指令来在线安装 TsFile 包
+
+```bash
+pip install tsfile
+```
+
+支持的架构平台如下：
+
+| Platform | python |
+| ------------- | -------------------------------- |
+| Linux_x86_64 | py39, py310, py311, py312, py313 |
+| Linus_aarch64 | py39, py310, py311, py312, py313 |
+| MacOS_arm64 | py39, py310, py311, py312, py313 |
+| MacOS_X86_64 | py39, py310, py311, py312, py313 |
+| Win_amd64 | py39, py310, py311, py312, py313 |
+
+或者直接下载 wheel 文件安装：https://pypi.org/project/tsfile/#files
+
+
### 在本地进行编译
从git克隆源代码:
@@ -76,18 +97,13 @@ mvnw.cmd clean install -P with-python -DskipTests
pip install tsfile.wheel
```
-### 使用 PIP 进行在线安装
-
-使用pip 指令来在线安装 TsFile 包
-
-```bash
-pip install tsfile
-```
-
## 写入示例
```Python
+import os
+from tsfile import *
+
table_data_dir = os.path.join(os.path.dirname(__file__), "table_data.tsfile")
if os.path.exists(table_data_dir):
os.remove(table_data_dir)
@@ -118,6 +134,9 @@ with TsFileTableWriter(table_data_dir, table_schema) as
writer:
## 读取示例
```Python
+import os
+from tsfile import *
+
table_data_dir = os.path.join(os.path.dirname(__file__), "table_data.tsfile")
### Free resource automatically
with TsFileReader(table_data_dir) as reader:
diff --git a/src/zh/UserGuide/latest/QuickStart/QuickStart.md
b/src/zh/UserGuide/latest/QuickStart/QuickStart.md
index b0c195f0..597ab831 100644
--- a/src/zh/UserGuide/latest/QuickStart/QuickStart.md
+++ b/src/zh/UserGuide/latest/QuickStart/QuickStart.md
@@ -27,24 +27,13 @@
## 安装
-从git克隆源代码:
-
-```shell
-git clone https://github.com/apache/tsfile.git
-```
-在 TsFile 根目录下执行 maven 编译:
-
-```shell
-mvn clean install -P with-java -DskipTests
-```
-
在 Maven 中引用 TsFile API:
```shell
<dependency>
<groupId>org.apache.tsfile</groupId>
<artifactId>tsfile</artifactId>
- <version>2.0.1</version>
+ <version>2.1.1</version>
</dependency>
```
