This is an automated email from the ASF dual-hosted git repository.
haonan pushed a commit to branch docs/dev
in repository https://gitbox.apache.org/repos/asf/tsfile.git
The following commit(s) were added to refs/heads/docs/dev by this push:
new 969e6499 2.x examples are based table model (#672)
969e6499 is described below
commit 969e6499399d8cd3f59ebc3febfa5ea9d2db160d
Author: leto-b <[email protected]>
AuthorDate: Mon Dec 22 11:53:57 2025 +0800
2.x examples are based table model (#672)
---
src/.vuepress/sidebar/v2.x/en.ts | 4 ++--
src/.vuepress/sidebar/v2.x/zh.ts | 4 ++--
src/UserGuide/develop/QuickStart/QuickStart-C.md | 1 +
src/UserGuide/develop/QuickStart/QuickStart-CPP.md | 2 ++
src/UserGuide/develop/QuickStart/QuickStart-JAVA.md | 1 +
src/UserGuide/develop/QuickStart/QuickStart-PYTHON.md | 6 +++++-
src/UserGuide/latest/QuickStart/QuickStart-C.md | 1 +
src/UserGuide/latest/QuickStart/QuickStart-CPP.md | 1 +
src/UserGuide/latest/QuickStart/QuickStart-PYTHON.md | 5 ++++-
src/UserGuide/latest/QuickStart/QuickStart.md | 1 +
src/zh/UserGuide/develop/QuickStart/QuickStart-C.md | 2 ++
src/zh/UserGuide/develop/QuickStart/QuickStart-CPP.md | 1 +
src/zh/UserGuide/develop/QuickStart/QuickStart-JAVA.md | 1 +
src/zh/UserGuide/develop/QuickStart/QuickStart-PYTHON.md | 4 +++-
src/zh/UserGuide/latest/QuickStart/QuickStart-C.md | 2 ++
src/zh/UserGuide/latest/QuickStart/QuickStart-CPP.md | 1 +
src/zh/UserGuide/latest/QuickStart/QuickStart-PYTHON.md | 5 ++++-
src/zh/UserGuide/latest/QuickStart/QuickStart.md | 1 +
18 files changed, 35 insertions(+), 8 deletions(-)
diff --git a/src/.vuepress/sidebar/v2.x/en.ts b/src/.vuepress/sidebar/v2.x/en.ts
index b0f22f9d..a6ac11d1 100644
--- a/src/.vuepress/sidebar/v2.x/en.ts
+++ b/src/.vuepress/sidebar/v2.x/en.ts
@@ -60,7 +60,7 @@ export const enSidebar = {
{ text: 'InterfaceDefinition-Python', link:
'InterfaceDefinition-Python' },
],
},
- {
+ /* {
text: 'Ecosystem Integration',
collapsible: true,
prefix: 'Ecosystem-Integration/',
@@ -69,6 +69,6 @@ export const enSidebar = {
{ text: 'Apache Spark', link: 'Spark-TsFile' },
{ text: 'Apache Hive', link: 'Hive-TsFile' },
],
- },
+ }, */
]
};
diff --git a/src/.vuepress/sidebar/v2.x/zh.ts b/src/.vuepress/sidebar/v2.x/zh.ts
index e790f4cb..f10fb411 100644
--- a/src/.vuepress/sidebar/v2.x/zh.ts
+++ b/src/.vuepress/sidebar/v2.x/zh.ts
@@ -60,7 +60,7 @@ export const zhSidebar = {
{ text: '接口定义-Python', link: 'InterfaceDefinition-Python' },
],
},
- {
+ /* {
text: '生态集成',
collapsible: true,
prefix: 'Ecosystem-Integration/',
@@ -69,6 +69,6 @@ export const zhSidebar = {
{ text: 'Apache Spark', link: 'Spark-TsFile' },
{ text: 'Apache Hive', link: 'Hive-TsFile' },
],
- },
+ }, */
]
};
diff --git a/src/UserGuide/develop/QuickStart/QuickStart-C.md
b/src/UserGuide/develop/QuickStart/QuickStart-C.md
index e65ddab2..0d03e452 100644
--- a/src/UserGuide/develop/QuickStart/QuickStart-C.md
+++ b/src/UserGuide/develop/QuickStart/QuickStart-C.md
@@ -261,3 +261,4 @@ The sample code of using these interfaces is in
<https://github.com/apache/tsfil
The sample code of using these interfaces is in
<https://github.com/apache/tsfile/blob/develop/cpp/examples/c_examples/demo_read.c>
+> Note: The above read/write examples are all based on the table model
interface. For details about the interface definition, please refer to [C
Interface Definition](./InterfaceDefinition/InterfaceDefinition-C.md). If you
need information regarding the tree model, please contact us.
diff --git a/src/UserGuide/develop/QuickStart/QuickStart-CPP.md
b/src/UserGuide/develop/QuickStart/QuickStart-CPP.md
index e6f78614..4f92b9d7 100644
--- a/src/UserGuide/develop/QuickStart/QuickStart-CPP.md
+++ b/src/UserGuide/develop/QuickStart/QuickStart-CPP.md
@@ -62,6 +62,7 @@ mvn clean install -P with-cpp -DskipTests \
- `Full build:` ~3.2MB
- `With ANTLR4 disabled:` ~1.9MB
- `With all compression algorithms disabled:` ~1.7MB
+
### Directory Structure
• **Include Directory**: Located at `tsfile/cpp/target/build/include`, it
contains header files for integration. Add this path to the compiler's include
path (e.g., using `-I` flag).
@@ -246,3 +247,4 @@ The sample code of using these interfaces is in
<https://github.com/apache/tsfil
The sample code of using these interfaces is in
<https://github.com/apache/tsfile/blob/develop/cpp/examples/cpp_examples/demo_read.cpp>
+> Note: The above read/write examples are all based on the table model
interface. For details about the interface definition, please refer to [C++
Interface Definition](./InterfaceDefinition/InterfaceDefinition-CPP.md). If you
need information regarding the tree model, please contact us.
diff --git a/src/UserGuide/develop/QuickStart/QuickStart-JAVA.md
b/src/UserGuide/develop/QuickStart/QuickStart-JAVA.md
index 79fe1535..5ccf42bd 100644
--- a/src/UserGuide/develop/QuickStart/QuickStart-JAVA.md
+++ b/src/UserGuide/develop/QuickStart/QuickStart-JAVA.md
@@ -174,3 +174,4 @@ reader.close();
The sample code of using these interfaces is in
<https://github.com/apache/tsfile/blob/develop/java/examples/src/main/java/org/apache/tsfile/v4/ITsFileReaderAndITsFileWriter.java>
+> Note: The above read/write examples are all based on the table model
interface. For details about the interface definition, please refer to [Java
Interface Definition](./InterfaceDefinition/InterfaceDefinition-Java.md). If
you need information regarding the tree model, please contact us.
diff --git a/src/UserGuide/develop/QuickStart/QuickStart-PYTHON.md
b/src/UserGuide/develop/QuickStart/QuickStart-PYTHON.md
index a25b3050..30207bb5 100644
--- a/src/UserGuide/develop/QuickStart/QuickStart-PYTHON.md
+++ b/src/UserGuide/develop/QuickStart/QuickStart-PYTHON.md
@@ -60,6 +60,7 @@ Platform support:
To download wheel from pypi: https://pypi.org/project/tsfile/#files
+
### Compile on your local envirment
Clone the source code from git:
@@ -149,4 +150,7 @@ with TsFileReader(table_data_dir) as reader:
## Sample Code
-The sample code of using these interfaces is
in：https://github.com/apache/tsfile/blob/develop/python/examples/example.py
\ No newline at end of file
+The sample code of using these interfaces is
in：https://github.com/apache/tsfile/blob/develop/python/examples/example.py
+
+> Note: The above read/write examples are all based on the table model
interface. For details about the interface definition, please refer to [Python
Interface Definition](./InterfaceDefinition/InterfaceDefinition-Python.md). If
you need information regarding the tree model, please contact us.
+
diff --git a/src/UserGuide/latest/QuickStart/QuickStart-C.md
b/src/UserGuide/latest/QuickStart/QuickStart-C.md
index e65ddab2..0d03e452 100644
--- a/src/UserGuide/latest/QuickStart/QuickStart-C.md
+++ b/src/UserGuide/latest/QuickStart/QuickStart-C.md
@@ -261,3 +261,4 @@ The sample code of using these interfaces is in
<https://github.com/apache/tsfil
The sample code of using these interfaces is in
<https://github.com/apache/tsfile/blob/develop/cpp/examples/c_examples/demo_read.c>
+> Note: The above read/write examples are all based on the table model
interface. For details about the interface definition, please refer to [C
Interface Definition](./InterfaceDefinition/InterfaceDefinition-C.md). If you
need information regarding the tree model, please contact us.
diff --git a/src/UserGuide/latest/QuickStart/QuickStart-CPP.md
b/src/UserGuide/latest/QuickStart/QuickStart-CPP.md
index ebb08b67..4f92b9d7 100644
--- a/src/UserGuide/latest/QuickStart/QuickStart-CPP.md
+++ b/src/UserGuide/latest/QuickStart/QuickStart-CPP.md
@@ -247,3 +247,4 @@ The sample code of using these interfaces is in
<https://github.com/apache/tsfil
The sample code of using these interfaces is in
<https://github.com/apache/tsfile/blob/develop/cpp/examples/cpp_examples/demo_read.cpp>
+> Note: The above read/write examples are all based on the table model
interface. For details about the interface definition, please refer to [C++
Interface Definition](./InterfaceDefinition/InterfaceDefinition-CPP.md). If you
need information regarding the tree model, please contact us.
diff --git a/src/UserGuide/latest/QuickStart/QuickStart-PYTHON.md
b/src/UserGuide/latest/QuickStart/QuickStart-PYTHON.md
index 03904746..30207bb5 100644
--- a/src/UserGuide/latest/QuickStart/QuickStart-PYTHON.md
+++ b/src/UserGuide/latest/QuickStart/QuickStart-PYTHON.md
@@ -150,4 +150,7 @@ with TsFileReader(table_data_dir) as reader:
## Sample Code
-The sample code of using these interfaces is
in：https://github.com/apache/tsfile/blob/develop/python/examples/example.py
\ No newline at end of file
+The sample code of using these interfaces is
in：https://github.com/apache/tsfile/blob/develop/python/examples/example.py
+
+> Note: The above read/write examples are all based on the table model
interface. For details about the interface definition, please refer to [Python
Interface Definition](./InterfaceDefinition/InterfaceDefinition-Python.md). If
you need information regarding the tree model, please contact us.
+
diff --git a/src/UserGuide/latest/QuickStart/QuickStart.md
b/src/UserGuide/latest/QuickStart/QuickStart.md
index 79fe1535..5ccf42bd 100644
--- a/src/UserGuide/latest/QuickStart/QuickStart.md
+++ b/src/UserGuide/latest/QuickStart/QuickStart.md
@@ -174,3 +174,4 @@ reader.close();
The sample code of using these interfaces is in
<https://github.com/apache/tsfile/blob/develop/java/examples/src/main/java/org/apache/tsfile/v4/ITsFileReaderAndITsFileWriter.java>
+> Note: The above read/write examples are all based on the table model
interface. For details about the interface definition, please refer to [Java
Interface Definition](./InterfaceDefinition/InterfaceDefinition-Java.md). If
you need information regarding the tree model, please contact us.
diff --git a/src/zh/UserGuide/develop/QuickStart/QuickStart-C.md
b/src/zh/UserGuide/develop/QuickStart/QuickStart-C.md
index a9f055d1..3f8c944f 100644
--- a/src/zh/UserGuide/develop/QuickStart/QuickStart-C.md
+++ b/src/zh/UserGuide/develop/QuickStart/QuickStart-C.md
@@ -262,3 +262,5 @@ The sample code of using these interfaces is in
<https://github.com/apache/tsfil
The sample code of using these interfaces is in
<https://github.com/apache/tsfile/blob/develop/cpp/examples/c_examples/demo_read.c>
+
+> 注意：以上读写示例均基于表模型接口，接口定义介绍可见[C
接口定义](./InterfaceDefinition/InterfaceDefinition-C.md)。若需了解树模型相关内容，请联系我们。
diff --git a/src/zh/UserGuide/develop/QuickStart/QuickStart-CPP.md
b/src/zh/UserGuide/develop/QuickStart/QuickStart-CPP.md
index 6a0a8ae0..6ff8228d 100644
--- a/src/zh/UserGuide/develop/QuickStart/QuickStart-CPP.md
+++ b/src/zh/UserGuide/develop/QuickStart/QuickStart-CPP.md
@@ -244,3 +244,4 @@ target_link_libraries(your_target ${TSFILE_LIB})
使用这些接口的示例代码可以在以下链接中找到
<https://github.com/apache/tsfile/blob/develop/cpp/examples/cpp_examples/demo_read.cpp>
+> 注意：以上读写示例均基于表模型接口，接口定义介绍可见[C++
接口定义](./InterfaceDefinition/InterfaceDefinition-CPP.md)。若需了解树模型相关内容，请联系我们。
diff --git a/src/zh/UserGuide/develop/QuickStart/QuickStart-JAVA.md
b/src/zh/UserGuide/develop/QuickStart/QuickStart-JAVA.md
index 1c6a8f87..36ec60d1 100644
--- a/src/zh/UserGuide/develop/QuickStart/QuickStart-JAVA.md
+++ b/src/zh/UserGuide/develop/QuickStart/QuickStart-JAVA.md
@@ -174,3 +174,4 @@ reader.close();
使用这些接口的示例代码位于：<https://github.com/apache/tsfile/blob/develop/java/examples/src/main/java/org/apache/tsfile/v4/ITsFileReaderAndITsFileWriter.java>
+> 注意：以上读写示例均基于表模型接口，接口定义介绍可见[Java
接口定义](./InterfaceDefinition/InterfaceDefinition-Java.md)。若需了解树模型相关内容，请联系我们。
diff --git a/src/zh/UserGuide/develop/QuickStart/QuickStart-PYTHON.md
b/src/zh/UserGuide/develop/QuickStart/QuickStart-PYTHON.md
index a1204432..b3aad522 100644
--- a/src/zh/UserGuide/develop/QuickStart/QuickStart-PYTHON.md
+++ b/src/zh/UserGuide/develop/QuickStart/QuickStart-PYTHON.md
@@ -151,4 +151,6 @@ with TsFileReader(table_data_dir) as reader:
## 示例代码
-使用这些接口的示例代码可以在以下链接中找到：https://github.com/apache/tsfile/blob/develop/python/examples/example.py
\ No newline at end of file
+使用这些接口的示例代码可以在以下链接中找到：https://github.com/apache/tsfile/blob/develop/python/examples/example.py
+
+> 注意：以上读写示例均基于表模型接口，接口定义介绍可见[Python
接口定义](./InterfaceDefinition/InterfaceDefinition-Python.md)。若需了解树模型相关内容，请联系我们。
diff --git a/src/zh/UserGuide/latest/QuickStart/QuickStart-C.md
b/src/zh/UserGuide/latest/QuickStart/QuickStart-C.md
index a9f055d1..3f8c944f 100644
--- a/src/zh/UserGuide/latest/QuickStart/QuickStart-C.md
+++ b/src/zh/UserGuide/latest/QuickStart/QuickStart-C.md
@@ -262,3 +262,5 @@ The sample code of using these interfaces is in
<https://github.com/apache/tsfil
The sample code of using these interfaces is in
<https://github.com/apache/tsfile/blob/develop/cpp/examples/c_examples/demo_read.c>
+
+> 注意：以上读写示例均基于表模型接口，接口定义介绍可见[C
接口定义](./InterfaceDefinition/InterfaceDefinition-C.md)。若需了解树模型相关内容，请联系我们。
diff --git a/src/zh/UserGuide/latest/QuickStart/QuickStart-CPP.md
b/src/zh/UserGuide/latest/QuickStart/QuickStart-CPP.md
index 6a0a8ae0..6ff8228d 100644
--- a/src/zh/UserGuide/latest/QuickStart/QuickStart-CPP.md
+++ b/src/zh/UserGuide/latest/QuickStart/QuickStart-CPP.md
@@ -244,3 +244,4 @@ target_link_libraries(your_target ${TSFILE_LIB})
使用这些接口的示例代码可以在以下链接中找到
<https://github.com/apache/tsfile/blob/develop/cpp/examples/cpp_examples/demo_read.cpp>
+> 注意：以上读写示例均基于表模型接口，接口定义介绍可见[C++
接口定义](./InterfaceDefinition/InterfaceDefinition-CPP.md)。若需了解树模型相关内容，请联系我们。
diff --git a/src/zh/UserGuide/latest/QuickStart/QuickStart-PYTHON.md
b/src/zh/UserGuide/latest/QuickStart/QuickStart-PYTHON.md
index a1204432..a4353d7f 100644
--- a/src/zh/UserGuide/latest/QuickStart/QuickStart-PYTHON.md
+++ b/src/zh/UserGuide/latest/QuickStart/QuickStart-PYTHON.md
@@ -151,4 +151,7 @@ with TsFileReader(table_data_dir) as reader:
## 示例代码
-使用这些接口的示例代码可以在以下链接中找到：https://github.com/apache/tsfile/blob/develop/python/examples/example.py
\ No newline at end of file
+使用这些接口的示例代码可以在以下链接中找到：https://github.com/apache/tsfile/blob/develop/python/examples/example.py
+
+> 注意：以上读写示例均基于表模型接口，接口定义介绍可见[Python
接口定义](./InterfaceDefinition/InterfaceDefinition-Python.md)。若需了解树模型相关内容，请联系我们。
+
diff --git a/src/zh/UserGuide/latest/QuickStart/QuickStart.md
b/src/zh/UserGuide/latest/QuickStart/QuickStart.md
index 1c6a8f87..36ec60d1 100644
--- a/src/zh/UserGuide/latest/QuickStart/QuickStart.md
+++ b/src/zh/UserGuide/latest/QuickStart/QuickStart.md
@@ -174,3 +174,4 @@ reader.close();
使用这些接口的示例代码位于：<https://github.com/apache/tsfile/blob/develop/java/examples/src/main/java/org/apache/tsfile/v4/ITsFileReaderAndITsFileWriter.java>
+> 注意：以上读写示例均基于表模型接口，接口定义介绍可见[Java
接口定义](./InterfaceDefinition/InterfaceDefinition-Java.md)。若需了解树模型相关内容，请联系我们。
