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
commit f0b621da17e4565d7167ad7842f6a5970d56e728 Author: ColinLee <[email protected]> AuthorDate: Mon Oct 27 11:05:41 2025 +0800 fix some api and example. --- .../QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md | 2 +- src/UserGuide/develop/QuickStart/QuickStart-PYTHON.md | 4 ++-- .../QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md | 2 +- src/UserGuide/latest/QuickStart/QuickStart-PYTHON.md | 4 ++-- .../QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md | 2 +- src/zh/UserGuide/develop/QuickStart/QuickStart-PYTHON.md | 4 ++-- .../QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md | 2 +- src/zh/UserGuide/latest/QuickStart/QuickStart-PYTHON.md | 4 ++-- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md b/src/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md index ad6d4619..4798efad 100644 --- a/src/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md +++ b/src/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md @@ -225,7 +225,7 @@ class ResultSet: :param max_row_num: The maximum number of rows to retrieve. Default is 1024. :return: A DataFrame containing data from the query result set. """ - def read_next_data_frame(self, max_row_num : int = 1024) -> DataFrame + def read_data_frame(self, max_row_num : int = 1024) -> DataFrame """ diff --git a/src/UserGuide/develop/QuickStart/QuickStart-PYTHON.md b/src/UserGuide/develop/QuickStart/QuickStart-PYTHON.md index 2d855a9e..2f2cb2b0 100644 --- a/src/UserGuide/develop/QuickStart/QuickStart-PYTHON.md +++ b/src/UserGuide/develop/QuickStart/QuickStart-PYTHON.md @@ -86,7 +86,7 @@ if os.path.exists(table_data_dir): column1 = ColumnSchema("id", TSDataType.STRING, ColumnCategory.TAG) column2 = ColumnSchema("id2", TSDataType.STRING, ColumnCategory.TAG) -column3 = ColumnSchema("value", TSDataType.FLOAT, ColumnCategory.FIELD) +column3 = ColumnSchema("value", TSDataType.DOUBLE, ColumnCategory.FIELD) table_schema = TableSchema("test_table", columns=[column1, column2, column3]) @@ -95,7 +95,7 @@ with TsFileTableWriter(table_data_dir, table_schema) as writer: tablet_row_num = 100 tablet = Tablet( ["id", "id2", "value"], - [TSDataType.STRING, TSDataType.STRING, TSDataType.FLOAT], + [TSDataType.STRING, TSDataType.STRING, TSDataType.DOUBLE], tablet_row_num) for i in range(tablet_row_num): diff --git a/src/UserGuide/latest/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md b/src/UserGuide/latest/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md index ad6d4619..4798efad 100644 --- a/src/UserGuide/latest/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md +++ b/src/UserGuide/latest/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md @@ -225,7 +225,7 @@ class ResultSet: :param max_row_num: The maximum number of rows to retrieve. Default is 1024. :return: A DataFrame containing data from the query result set. """ - def read_next_data_frame(self, max_row_num : int = 1024) -> DataFrame + def read_data_frame(self, max_row_num : int = 1024) -> DataFrame """ diff --git a/src/UserGuide/latest/QuickStart/QuickStart-PYTHON.md b/src/UserGuide/latest/QuickStart/QuickStart-PYTHON.md index 2d855a9e..2f2cb2b0 100644 --- a/src/UserGuide/latest/QuickStart/QuickStart-PYTHON.md +++ b/src/UserGuide/latest/QuickStart/QuickStart-PYTHON.md @@ -86,7 +86,7 @@ if os.path.exists(table_data_dir): column1 = ColumnSchema("id", TSDataType.STRING, ColumnCategory.TAG) column2 = ColumnSchema("id2", TSDataType.STRING, ColumnCategory.TAG) -column3 = ColumnSchema("value", TSDataType.FLOAT, ColumnCategory.FIELD) +column3 = ColumnSchema("value", TSDataType.DOUBLE, ColumnCategory.FIELD) table_schema = TableSchema("test_table", columns=[column1, column2, column3]) @@ -95,7 +95,7 @@ with TsFileTableWriter(table_data_dir, table_schema) as writer: tablet_row_num = 100 tablet = Tablet( ["id", "id2", "value"], - [TSDataType.STRING, TSDataType.STRING, TSDataType.FLOAT], + [TSDataType.STRING, TSDataType.STRING, TSDataType.DOUBLE], tablet_row_num) for i in range(tablet_row_num): diff --git a/src/zh/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md b/src/zh/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md index 157d8cba..7143a583 100644 --- a/src/zh/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md +++ b/src/zh/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md @@ -214,7 +214,7 @@ class ResultSet: :param max_row_num: 要读取的最大行数，默认值为 1024。 :return: 包含查询结果数据的 DataFrame。 """ - def read_next_data_frame(self, max_row_num : int = 1024) -> DataFrame + def read_data_frame(self, max_row_num : int = 1024) -> DataFrame """ 从查询结果集中按索引获取值。 diff --git a/src/zh/UserGuide/develop/QuickStart/QuickStart-PYTHON.md b/src/zh/UserGuide/develop/QuickStart/QuickStart-PYTHON.md index 6d0b32cd..6978bede 100644 --- a/src/zh/UserGuide/develop/QuickStart/QuickStart-PYTHON.md +++ b/src/zh/UserGuide/develop/QuickStart/QuickStart-PYTHON.md @@ -94,7 +94,7 @@ if os.path.exists(table_data_dir): column1 = ColumnSchema("id", TSDataType.STRING, ColumnCategory.TAG) column2 = ColumnSchema("id2", TSDataType.STRING, ColumnCategory.TAG) -column3 = ColumnSchema("value", TSDataType.FLOAT, ColumnCategory.FIELD) +column3 = ColumnSchema("value", TSDataType.DOUBLE, ColumnCategory.FIELD) table_schema = TableSchema("test_table", columns=[column1, column2, column3]) @@ -103,7 +103,7 @@ with TsFileTableWriter(table_data_dir, table_schema) as writer: tablet_row_num = 100 tablet = Tablet( ["id", "id2", "value"], - [TSDataType.STRING, TSDataType.STRING, TSDataType.FLOAT], + [TSDataType.STRING, TSDataType.STRING, TSDataType.DOUBLE], tablet_row_num) for i in range(tablet_row_num): diff --git a/src/zh/UserGuide/latest/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md b/src/zh/UserGuide/latest/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md index 157d8cba..7143a583 100644 --- a/src/zh/UserGuide/latest/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md +++ b/src/zh/UserGuide/latest/QuickStart/InterfaceDefinition/InterfaceDefinition-Python.md @@ -214,7 +214,7 @@ class ResultSet: :param max_row_num: 要读取的最大行数，默认值为 1024。 :return: 包含查询结果数据的 DataFrame。 """ - def read_next_data_frame(self, max_row_num : int = 1024) -> DataFrame + def read_data_frame(self, max_row_num : int = 1024) -> DataFrame """ 从查询结果集中按索引获取值。 diff --git a/src/zh/UserGuide/latest/QuickStart/QuickStart-PYTHON.md b/src/zh/UserGuide/latest/QuickStart/QuickStart-PYTHON.md index 6d0b32cd..6978bede 100644 --- a/src/zh/UserGuide/latest/QuickStart/QuickStart-PYTHON.md +++ b/src/zh/UserGuide/latest/QuickStart/QuickStart-PYTHON.md @@ -94,7 +94,7 @@ if os.path.exists(table_data_dir): column1 = ColumnSchema("id", TSDataType.STRING, ColumnCategory.TAG) column2 = ColumnSchema("id2", TSDataType.STRING, ColumnCategory.TAG) -column3 = ColumnSchema("value", TSDataType.FLOAT, ColumnCategory.FIELD) +column3 = ColumnSchema("value", TSDataType.DOUBLE, ColumnCategory.FIELD) table_schema = TableSchema("test_table", columns=[column1, column2, column3]) @@ -103,7 +103,7 @@ with TsFileTableWriter(table_data_dir, table_schema) as writer: tablet_row_num = 100 tablet = Tablet( ["id", "id2", "value"], - [TSDataType.STRING, TSDataType.STRING, TSDataType.FLOAT], + [TSDataType.STRING, TSDataType.STRING, TSDataType.DOUBLE], tablet_row_num) for i in range(tablet_row_num):
