diff --git a/cpp/src/cwrapper/tsfile_cwrapper.cc b/cpp/src/cwrapper/tsfile_cwrapper.cc index 7c22ccd5c..f384698ba 100644 --- a/cpp/src/cwrapper/tsfile_cwrapper.cc +++ b/cpp/src/cwrapper/tsfile_cwrapper.cc @@ -116,6 +116,10 @@ TsFileWriter tsfile_writer_new(WriteFile file, TableSchema* schema, *err_code = common::E_INVALID_SCHEMA; return nullptr; } + // Ignore time column definition. + if (cur_schema.column_category == TIME) { + continue; + } column_schemas.emplace_back( cur_schema.column_name, @@ -687,6 +691,9 @@ ERRNO _tsfile_writer_register_table(TsFileWriter writer, TableSchema* schema) { measurement_schemas.resize(schema->column_num); for (int i = 0; i < schema->column_num; i++) { ColumnSchema* cur_schema = schema->column_schemas + i; + if (cur_schema->column_category == TIME) { + continue; + } measurement_schemas[i] = new storage::MeasurementSchema( cur_schema->column_name, static_cast(cur_schema->data_type)); diff --git a/cpp/src/cwrapper/tsfile_cwrapper.h b/cpp/src/cwrapper/tsfile_cwrapper.h index d9fe6bb85..643b4e52b 100644 --- a/cpp/src/cwrapper/tsfile_cwrapper.h +++ b/cpp/src/cwrapper/tsfile_cwrapper.h @@ -71,7 +71,12 @@ typedef enum { TS_COMPRESSION_INVALID = 255 } CompressionType; -typedef enum column_category { TAG = 0, FIELD = 1 } ColumnCategory; +typedef enum column_category { + TAG = 0, + FIELD = 1, + ATTRIBUTE = 2, + TIME = 3 +} ColumnCategory; typedef struct column_schema { char* column_name; diff --git a/python/tests/test_basic.py b/python/tests/test_basic.py index 842a8fb44..675ef837f 100644 --- a/python/tests/test_basic.py +++ b/python/tests/test_basic.py @@ -17,7 +17,7 @@ # import numpy as np import pytest -from tsfile import schema, Field +from tsfile import Field from tsfile import Tablet from tsfile.constants import * from tsfile.schema import * diff --git a/python/tests/test_dataframe.py b/python/tests/test_dataframe.py new file mode 100644 index 000000000..09d0001ba --- /dev/null +++ b/python/tests/test_dataframe.py @@ -0,0 +1,320 @@ +# 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. +# +import os +from datetime import date + +import numpy as np +import pandas as pd +import pytest + +from tsfile import ColumnSchema, TableSchema, TSDataType +from tsfile import TsFileTableWriter, ColumnCategory +from tsfile import to_dataframe +from tsfile.exceptions import ColumnNotExistError, TypeMismatchError + + +def convert_to_nullable_types(df): + """ + Convert DataFrame columns to nullable types to match returned DataFrame from to_dataframe. + This handles the fact that returned DataFrames use nullable types (Int64, Float64, etc.) + to support Null values. + """ + df = df.copy() + for col in df.columns: + dtype = df[col].dtype + if dtype == 'int64': + df[col] = df[col].astype('Int64') + elif dtype == 'int32': + df[col] = df[col].astype('Int32') + elif dtype == 'float64': + df[col] = df[col].astype('Float64') + elif dtype == 'float32': + df[col] = df[col].astype('Float32') + elif dtype == 'bool': + df[col] = df[col].astype('boolean') + return df + + +def test_write_dataframe_basic(): + table = TableSchema("test_table", + [ColumnSchema("device", TSDataType.STRING, ColumnCategory.TAG), + ColumnSchema("value", TSDataType.DOUBLE, ColumnCategory.FIELD), + ColumnSchema("value2", TSDataType.INT64, ColumnCategory.FIELD)]) + tsfile_path = "test_write_dataframe_basic.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + with TsFileTableWriter(tsfile_path, table) as writer: + df = pd.DataFrame({ + 'time': [i for i in range(100)], + 'device': [f"device{i}" for i in range(100)], + 'value': [i * 1.5 for i in range(100)], + 'value2': [i * 10 for i in range(100)] + }) + writer.write_dataframe(df) + + df_read = to_dataframe(tsfile_path, table_name="test_table") + df_read = df_read.sort_values('time').reset_index(drop=True) + df_sorted = convert_to_nullable_types(df.sort_values('time').reset_index(drop=True)) + assert df_read.shape == (100, 4) + assert df_read["time"].equals(df_sorted["time"]) + assert df_read["device"].equals(df_sorted["device"]) + assert df_read["value"].equals(df_sorted["value"]) + assert df_read["value2"].equals(df_sorted["value2"]) + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_write_dataframe_with_index(): + table = TableSchema("test_table", + [ColumnSchema("device", TSDataType.STRING, ColumnCategory.TAG), + ColumnSchema("value", TSDataType.DOUBLE, ColumnCategory.FIELD)]) + tsfile_path = "test_write_dataframe_index.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + with TsFileTableWriter(tsfile_path, table) as writer: + df = pd.DataFrame({ + 'device': [f"device{i}" for i in range(50)], + 'value': [i * 2.5 for i in range(50)] + }) + df.index = [i * 10 for i in range(50)] # Set index as timestamps + writer.write_dataframe(df) + df_read = to_dataframe(tsfile_path, table_name="test_table") + df_read = df_read.sort_values('time').reset_index(drop=True) + df_sorted = df.sort_index() + df_sorted = convert_to_nullable_types(df_sorted.reset_index(drop=True)) + time_series = pd.Series(df.sort_index().index.values, dtype='Int64') + assert df_read.shape == (50, 3) + assert df_read["time"].equals(time_series) + assert df_read["device"].equals(df_sorted["device"]) + assert df_read["value"].equals(df_sorted["value"]) + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_write_dataframe_case_insensitive(): + table = TableSchema("test_table", + [ColumnSchema("device", TSDataType.STRING, ColumnCategory.TAG), + ColumnSchema("value", TSDataType.DOUBLE, ColumnCategory.FIELD)]) + tsfile_path = "test_write_dataframe_case.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + with TsFileTableWriter(tsfile_path, table) as writer: + df = pd.DataFrame({ + 'Time': [i for i in range(30)], # Capital T + 'Device': [f"device{i}" for i in range(30)], # Capital D + 'VALUE': [i * 3.0 for i in range(30)] # All caps + }) + writer.write_dataframe(df) + + df_read = to_dataframe(tsfile_path, table_name="test_table") + df_read = df_read.sort_values('time').reset_index(drop=True) + df_sorted = convert_to_nullable_types(df.sort_values('Time').reset_index(drop=True)) + assert df_read.shape == (30, 3) + assert df_read["time"].equals(df_sorted["Time"]) + assert df_read["device"].equals(df_sorted["Device"]) + assert df_read["value"].equals(df_sorted["VALUE"]) + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_write_dataframe_column_not_in_schema(): + table = TableSchema("test_table", + [ColumnSchema("device", TSDataType.STRING, ColumnCategory.TAG), + ColumnSchema("value", TSDataType.DOUBLE, ColumnCategory.FIELD)]) + tsfile_path = "test_write_dataframe_extra_col.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + with TsFileTableWriter(tsfile_path, table) as writer: + df = pd.DataFrame({ + 'time': [i for i in range(10)], + 'device': [f"device{i}" for i in range(10)], + 'value': [i * 1.0 for i in range(10)], + 'extra_column': [i for i in range(10)] # Not in schema + }) + with pytest.raises(ColumnNotExistError): + writer.write_dataframe(df) + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_write_dataframe_type_mismatch(): + table = TableSchema("test_table", + [ColumnSchema("value", TSDataType.STRING, ColumnCategory.FIELD)]) + tsfile_path = "test_write_dataframe_type_mismatch.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + with TsFileTableWriter(tsfile_path, table) as writer: + df = pd.DataFrame({ + 'time': [i for i in range(10)], + 'value': [i for i in range(10)] + }) + with pytest.raises(TypeMismatchError) as exc_info: + writer.write_dataframe(df) + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_write_dataframe_all_datatypes(): + table = TableSchema("test_table", + [ColumnSchema("bool_col", TSDataType.BOOLEAN, ColumnCategory.FIELD), + ColumnSchema("int32_col", TSDataType.INT32, ColumnCategory.FIELD), + ColumnSchema("int64_col", TSDataType.INT64, ColumnCategory.FIELD), + ColumnSchema("float_col", TSDataType.FLOAT, ColumnCategory.FIELD), + ColumnSchema("double_col", TSDataType.DOUBLE, ColumnCategory.FIELD), + ColumnSchema("string_col", TSDataType.STRING, ColumnCategory.FIELD), + ColumnSchema("blob_col", TSDataType.BLOB, ColumnCategory.FIELD), + ColumnSchema("text_col", TSDataType.TEXT, ColumnCategory.FIELD), + ColumnSchema("date_col", TSDataType.DATE, ColumnCategory.FIELD), + ColumnSchema("timestamp_col", TSDataType.TIMESTAMP, ColumnCategory.FIELD)]) + tsfile_path = "test_write_dataframe_all_types.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + with TsFileTableWriter(tsfile_path, table) as writer: + df = pd.DataFrame({ + 'time': [i for i in range(50)], + 'bool_col': [i % 2 == 0 for i in range(50)], + 'int32_col': pd.Series([i for i in range(50)], dtype='int32'), + 'int64_col': [i * 10 for i in range(50)], + 'float_col': pd.Series([i * 1.5 for i in range(50)], dtype='float32'), + 'double_col': [i * 2.5 for i in range(50)], + 'string_col': [f"str{i}" for i in range(50)], + 'blob_col': [f"blob{i}".encode('utf-8') for i in range(50)], + 'text_col': [f"text{i}" for i in range(50)], + 'date_col': [date(2025, i % 11 + 1, i % 20 + 1) for i in range(50)], + 'timestamp_col': [i for i in range(50)] + }) + writer.write_dataframe(df) + + df_read = to_dataframe(tsfile_path, table_name="test_table") + df_read = df_read.sort_values('time').reset_index(drop=True) + df_sorted = convert_to_nullable_types(df.sort_values('time').reset_index(drop=True)) + assert df_read.shape == (50, 11) + assert df_read["bool_col"].equals(df_sorted["bool_col"]) + assert df_read["int32_col"].equals(df_sorted["int32_col"]) + assert df_read["int64_col"].equals(df_sorted["int64_col"]) + assert np.allclose(df_read["float_col"], df_sorted["float_col"]) + assert np.allclose(df_read["double_col"], df_sorted["double_col"]) + assert df_read["string_col"].equals(df_sorted["string_col"]) + assert df_read["blob_col"].equals(df_sorted["blob_col"]) + assert df_read["text_col"].equals(df_sorted["text_col"]) + assert df_read["date_col"].equals(df_sorted["date_col"]) + assert df_read["timestamp_col"].equals(df_sorted["timestamp_col"]) + for i in range(50): + assert df_read["blob_col"].iloc[i] == df_sorted["blob_col"].iloc[i] + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_write_dataframe_schema_time_column(): + table = TableSchema("test_table", + [ColumnSchema("time", TSDataType.TIMESTAMP, ColumnCategory.TIME), + ColumnSchema("device", TSDataType.STRING, ColumnCategory.TAG), + ColumnSchema("value", TSDataType.DOUBLE, ColumnCategory.FIELD)]) + tsfile_path = "test_write_dataframe_schema_time.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + with TsFileTableWriter(tsfile_path, table) as writer: + df = pd.DataFrame({ + 'time': [i * 100 for i in range(50)], + 'device': [f"device{i}" for i in range(50)], + 'value': [i * 1.5 for i in range(50)] + }) + writer.write_dataframe(df) + + df_read = to_dataframe(tsfile_path, table_name="test_table") + df_read = df_read.sort_values('time').reset_index(drop=True) + df_sorted = convert_to_nullable_types(df.sort_values('time').reset_index(drop=True)) + assert df_read.shape == (50, 3) + assert df_read["time"].equals(df_sorted["time"]) + assert df_read["device"].equals(df_sorted["device"]) + assert df_read["value"].equals(df_sorted["value"]) + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_write_dataframe_schema_time_and_dataframe_time(): + table = TableSchema("test_table", + [ColumnSchema("device", TSDataType.STRING, ColumnCategory.TAG), + ColumnSchema("value", TSDataType.DOUBLE, ColumnCategory.FIELD)]) + tsfile_path = "test_write_dataframe_schema_and_df_time.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + with TsFileTableWriter(tsfile_path, table) as writer: + df = pd.DataFrame({ + 'Time': [i for i in range(30)], + 'device': [f"dev{i}" for i in range(30)], + 'value': [float(i) for i in range(30)] + }) + writer.write_dataframe(df) + + df_read = to_dataframe(tsfile_path, table_name="test_table") + df_read = df_read.sort_values('time').reset_index(drop=True) + df_sorted = convert_to_nullable_types( + df.sort_values('Time').rename(columns=str.lower).reset_index(drop=True) + ) + assert df_read.shape == (30, 3) + assert df_read["time"].equals(df_sorted["time"]) + assert df_read["device"].equals(df_sorted["device"]) + assert df_read["value"].equals(df_sorted["value"]) + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_write_dataframe_empty(): + table = TableSchema("test_table", + [ColumnSchema("value", TSDataType.DOUBLE, ColumnCategory.FIELD)]) + tsfile_path = "test_write_dataframe_empty.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + with TsFileTableWriter(tsfile_path, table) as writer: + df = pd.DataFrame({ + 'time': [], + 'value': [] + }) + with pytest.raises(ValueError) as err: + writer.write_dataframe(df) + + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) diff --git a/python/tests/test_to_tsfile.py b/python/tests/test_to_tsfile.py new file mode 100644 index 000000000..c3a970e3c --- /dev/null +++ b/python/tests/test_to_tsfile.py @@ -0,0 +1,378 @@ +# 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. +# +import os +from datetime import date + +import numpy as np +import pandas as pd +import pytest + +from tsfile import to_dataframe, TsFileReader, ColumnCategory +from tsfile.utils import dataframe_to_tsfile + + +def convert_to_nullable_types(df): + df = df.copy() + for col in df.columns: + dtype = df[col].dtype + if dtype == 'int64': + df[col] = df[col].astype('Int64') + elif dtype == 'int32': + df[col] = df[col].astype('Int32') + elif dtype == 'float64': + df[col] = df[col].astype('Float64') + elif dtype == 'float32': + df[col] = df[col].astype('Float32') + elif dtype == 'bool': + df[col] = df[col].astype('boolean') + return df + + +def test_dataframe_to_tsfile_basic(): + tsfile_path = "test_dataframe_to_tsfile_basic.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + df = pd.DataFrame({ + 'time': [i for i in range(100)], + 'device': [f"device{i}" for i in range(100)], + 'value': [i * 1.5 for i in range(100)], + 'value2': [i * 10 for i in range(100)] + }) + + dataframe_to_tsfile(df, tsfile_path, table_name="test_table") + + df_read = to_dataframe(tsfile_path, table_name="test_table") + df_read = df_read.sort_values('time').reset_index(drop=True) + df_sorted = convert_to_nullable_types(df.sort_values('time').reset_index(drop=True)) + + assert df_read.shape == (100, 4) + assert df_read["time"].equals(df_sorted["time"]) + assert df_read["device"].equals(df_sorted["device"]) + assert df_read["value"].equals(df_sorted["value"]) + assert df_read["value2"].equals(df_sorted["value2"]) + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_dataframe_to_tsfile_default_table_name(): + tsfile_path = "test_dataframe_to_tsfile_default.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + df = pd.DataFrame({'time': [0, 1], 'value': [1.0, 2.0]}) + dataframe_to_tsfile(df, tsfile_path) + + df_read = to_dataframe(tsfile_path, table_name="default_table") + assert len(df_read) == 2 + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_dataframe_to_tsfile_with_index(): + tsfile_path = "test_dataframe_to_tsfile_index.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + df = pd.DataFrame({ + 'device': [f"device{i}" for i in range(30)], + 'value': [i * 2.0 for i in range(30)] + }) + df.index = [i * 100 for i in range(30)] + dataframe_to_tsfile(df, tsfile_path, table_name="test_table") + + df_read = to_dataframe(tsfile_path, table_name="test_table") + df_read = df_read.sort_values('time').reset_index(drop=True) + time_expected = pd.Series(df.index.values, dtype='Int64') + assert df_read.shape == (30, 3) + assert df_read["time"].equals(time_expected) + + with TsFileReader(tsfile_path) as reader: + table_schema = reader.get_table_schema("test_table") + device_col = table_schema.get_column("device") + assert device_col is not None + assert device_col.get_category() == ColumnCategory.FIELD + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_dataframe_to_tsfile_custom_time_column(): + tsfile_path = "test_dataframe_to_tsfile_custom_time.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + df = pd.DataFrame({ + 'timestamp': [i for i in range(30)], + 'device': [f"device{i}" for i in range(30)], + 'value': [i * 3.0 for i in range(30)] + }) + + dataframe_to_tsfile(df, tsfile_path, table_name="test_table", time_column="timestamp") + + df_read = to_dataframe(tsfile_path, table_name="test_table") + df_read = df_read.sort_values('time').reset_index(drop=True) + df_sorted = convert_to_nullable_types(df.sort_values('timestamp').reset_index(drop=True)) + + assert df_read.shape == (30, 3) + assert df_read["time"].equals(df_sorted["timestamp"]) + assert df_read["device"].equals(df_sorted["device"]) + assert df_read["value"].equals(df_sorted["value"]) + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_dataframe_to_tsfile_case_insensitive_time(): + tsfile_path = "test_dataframe_to_tsfile_case_time.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + df = pd.DataFrame({ + 'Time': [i for i in range(20)], + 'value': [i * 2.0 for i in range(20)] + }) + + dataframe_to_tsfile(df, tsfile_path, table_name="test_table") + + df_read = to_dataframe(tsfile_path, table_name="test_table") + assert df_read.shape == (20, 2) + assert df_read["time"].equals(pd.Series([i for i in range(20)], dtype='Int64')) + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_dataframe_to_tsfile_with_tag_columns(): + tsfile_path = "test_dataframe_to_tsfile_tags.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + df = pd.DataFrame({ + 'time': [i for i in range(20)], + 'device': [f"device{i}" for i in range(20)], + 'location': [f"loc{i % 5}" for i in range(20)], + 'value': [i * 1.5 for i in range(20)] + }) + + dataframe_to_tsfile(df, tsfile_path, table_name="test_table", tag_column=["device", "location"]) + + df_read = to_dataframe(tsfile_path, table_name="test_table") + df_read = df_read.sort_values('time').reset_index(drop=True) + df_sorted = convert_to_nullable_types(df.sort_values('time').reset_index(drop=True)) + + assert df_read.shape == (20, 4) + assert df_read["device"].equals(df_sorted["device"]) + assert df_read["location"].equals(df_sorted["location"]) + assert df_read["value"].equals(df_sorted["value"]) + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_dataframe_to_tsfile_tag_time_unsorted(): + tsfile_path = "test_dataframe_to_tsfile_tag_time_unsorted.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + df = pd.DataFrame({ + 'time': [30, 10, 20, 50, 40, 15, 25, 35, 5, 45], + 'device': ['device1', 'device1', 'device1', 'device2', 'device2', 'device1', 'device1', 'device2', + 'device1', 'device2'], + 'value': [i * 1.5 for i in range(10)] + }) + + dataframe_to_tsfile(df, tsfile_path, table_name="test_table", tag_column=["device"]) + + df_read = to_dataframe(tsfile_path, table_name="test_table") + df_expected = df.sort_values(by=['device', 'time']).reset_index(drop=True) + df_expected = convert_to_nullable_types(df_expected) + + assert df_read.shape == (10, 3) + assert df_read["device"].equals(df_expected["device"]) + assert df_read["time"].equals(df_expected["time"]) + assert df_read["value"].equals(df_expected["value"]) + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_dataframe_to_tsfile_all_datatypes(): + tsfile_path = "test_dataframe_to_tsfile_all_types.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + df = pd.DataFrame({ + 'time': [i for i in range(50)], + 'bool_col': [i % 2 == 0 for i in range(50)], + 'int32_col': pd.Series([i for i in range(50)], dtype='int32'), + 'int64_col': [i * 10 for i in range(50)], + 'float_col': pd.Series([i * 1.5 for i in range(50)], dtype='float32'), + 'double_col': [i * 2.5 for i in range(50)], + 'string_col': [f"str{i}" for i in range(50)], + 'blob_col': [f"blob{i}".encode('utf-8') for i in range(50)], + 'text_col': [f"text{i}" for i in range(50)], + 'date_col': [date(2025, i % 11 + 1, i % 20 + 1) for i in range(50)], + 'timestamp_col': [i for i in range(50)] + }) + + dataframe_to_tsfile(df, tsfile_path, table_name="test_table") + + df_read = to_dataframe(tsfile_path, table_name="test_table") + df_read = df_read.sort_values('time').reset_index(drop=True) + df_sorted = convert_to_nullable_types(df.sort_values('time').reset_index(drop=True)) + + assert df_read.shape == (50, 11) + assert df_read["bool_col"].equals(df_sorted["bool_col"]) + assert df_read["int32_col"].equals(df_sorted["int32_col"]) + assert df_read["int64_col"].equals(df_sorted["int64_col"]) + assert np.allclose(df_read["float_col"], df_sorted["float_col"]) + assert np.allclose(df_read["double_col"], df_sorted["double_col"]) + assert df_read["string_col"].equals(df_sorted["string_col"]) + assert df_read["text_col"].equals(df_sorted["text_col"]) + assert df_read["date_col"].equals(df_sorted["date_col"]) + assert df_read["timestamp_col"].equals(df_sorted["timestamp_col"]) + for i in range(50): + assert df_read["blob_col"].iloc[i] == df_sorted["blob_col"].iloc[i] + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_dataframe_to_tsfile_empty_dataframe(): + tsfile_path = "test_dataframe_to_tsfile_empty.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + df = pd.DataFrame() + + with pytest.raises(ValueError, match="DataFrame cannot be None or empty"): + dataframe_to_tsfile(df, tsfile_path) + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_dataframe_to_tsfile_no_data_columns(): + tsfile_path = "test_dataframe_to_tsfile_no_data.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + df = pd.DataFrame({ + 'time': [i for i in range(10)] + }) + + with pytest.raises(ValueError, match="DataFrame must have at least one data column"): + dataframe_to_tsfile(df, tsfile_path) + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_dataframe_to_tsfile_time_column_not_found(): + tsfile_path = "test_dataframe_to_tsfile_time_err.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + df = pd.DataFrame({'time': [0, 1], 'value': [1.0, 2.0]}) + with pytest.raises(ValueError, match="Time column 'timestamp' not found"): + dataframe_to_tsfile(df, tsfile_path, time_column="timestamp") + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_dataframe_to_tsfile_invalid_time_column(): + tsfile_path = "test_dataframe_to_tsfile_invalid_time.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + df = pd.DataFrame({ + 'timestamp': [i for i in range(10)], + 'value': [i * 1.0 for i in range(10)] + }) + + with pytest.raises(ValueError, match="Time column 'time' not found"): + dataframe_to_tsfile(df, tsfile_path, time_column="time") + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_dataframe_to_tsfile_non_integer_time_column(): + tsfile_path = "test_dataframe_to_tsfile_non_int_time.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + df = pd.DataFrame({ + 'time': [f"time{i}" for i in range(10)], + 'value': [i * 1.0 for i in range(10)] + }) + + with pytest.raises(TypeError, match="must be integer type"): + dataframe_to_tsfile(df, tsfile_path) + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_dataframe_to_tsfile_tag_column_not_found(): + tsfile_path = "test_dataframe_to_tsfile_tag_err.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + df = pd.DataFrame({'time': [0, 1], 'device': ['a', 'b'], 'value': [1.0, 2.0]}) + with pytest.raises(ValueError, match="Tag column 'invalid' not found"): + dataframe_to_tsfile(df, tsfile_path, tag_column=["invalid"]) + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + +def test_dataframe_to_tsfile_invalid_tag_column(): + tsfile_path = "test_dataframe_to_tsfile_invalid_tag.tsfile" + try: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) + + df = pd.DataFrame({ + 'time': [i for i in range(10)], + 'value': [i * 1.0 for i in range(10)] + }) + + with pytest.raises(ValueError, match="Tag column 'invalid' not found"): + dataframe_to_tsfile(df, tsfile_path, tag_column=["invalid"]) + finally: + if os.path.exists(tsfile_path): + os.remove(tsfile_path) diff --git a/python/tests/test_write_and_read.py b/python/tests/test_write_and_read.py index b327e2d3d..3cef99c4a 100644 --- a/python/tests/test_write_and_read.py +++ b/python/tests/test_write_and_read.py @@ -16,11 +16,13 @@ # under the License. # +import os from datetime import date import numpy as np import pandas as pd import pytest +from pandas import Float64Dtype from pandas.core.dtypes.common import is_integer_dtype from tsfile import ColumnSchema, TableSchema, TSEncoding @@ -31,7 +33,7 @@ from tsfile import TsFileTableWriter from tsfile import TsFileWriter, TsFileReader, ColumnCategory from tsfile import to_dataframe -from tsfile.exceptions import TableNotExistError, ColumnNotExistError, NotSupportedError +from tsfile.exceptions import TableNotExistError, ColumnNotExistError, NotSupportedError, TypeMismatchError def test_row_record_write_and_read(): @@ -82,7 +84,7 @@ def test_row_record_write_and_read(): assert result.get_value_by_index(4) == row_num * 2 assert result.get_value_by_index(5) == f"string_value_{row_num}" assert result.get_value_by_index(6) == f"text_value_{row_num}" - assert result.get_value_by_index(7) == f"blob_data_{row_num}" + assert result.get_value_by_index(7) == f"blob_data_{row_num}".encode('utf-8') assert result.get_value_by_index(8) == date(2025, 1, row_num % 20 + 1) assert result.get_value_by_index(9) == row_num @@ -544,7 +546,7 @@ def test_tsfile_to_df(): assert df1.shape == (4097, 4) assert df1["value2"].sum() == 100 * (1 + 4096) / 2 * 4096 assert is_integer_dtype(df1["time"]) - assert df1["value"].dtype == np.float64 + assert df1["value"].dtype == Float64Dtype() assert is_integer_dtype(df1["value2"]) df2 = to_dataframe("table_write_to_df.tsfile", column_names=["device", "value2"]) assert df2.shape == (4097, 3) @@ -755,237 +757,9 @@ def test_tree_all_datatype_query_to_dataframe_variants(): pass finally: - if os.path.exists(tsfile_path): - os.remove(tsfile_path) - - -def test_table_all_datatype_query_to_dataframe_variants(): - tsfile_path = "test_table.tsfile" - table = TableSchema( - "test_table", - [ - ColumnSchema("Device1", TSDataType.STRING, ColumnCategory.TAG), - ColumnSchema("Device2", TSDataType.STRING, ColumnCategory.TAG), - ColumnSchema("Value1", TSDataType.BOOLEAN, ColumnCategory.FIELD), - ColumnSchema("Value2", TSDataType.INT32, ColumnCategory.FIELD), - ColumnSchema("Value3", TSDataType.INT64, ColumnCategory.FIELD), - ColumnSchema("Value4", TSDataType.FLOAT, ColumnCategory.FIELD), - ColumnSchema("Value5", TSDataType.DOUBLE, ColumnCategory.FIELD), - ColumnSchema("Value6", TSDataType.TEXT, ColumnCategory.FIELD), - ColumnSchema("Value7", TSDataType.STRING, ColumnCategory.FIELD), - ColumnSchema("Value8", TSDataType.BLOB, ColumnCategory.FIELD), - ColumnSchema("Value9", TSDataType.TIMESTAMP, ColumnCategory.FIELD), - ColumnSchema("Value10", TSDataType.DATE, ColumnCategory.FIELD), - ], - ) - dateSet = set() - try: - if os.path.exists(tsfile_path): - os.remove(tsfile_path) - max_row_num = 100 - with TsFileTableWriter(tsfile_path, table) as writer: - tablet = Tablet( - [ - "Device1", - "Device2", - "Value1", - "Value2", - "Value3", - "Value4", - "Value5", - "Value6", - "Value7", - "Value8", - "Value9", - "Value10", - ], - [ - TSDataType.STRING, - TSDataType.STRING, - TSDataType.BOOLEAN, - TSDataType.INT32, - TSDataType.INT64, - TSDataType.FLOAT, - TSDataType.DOUBLE, - TSDataType.TEXT, - TSDataType.STRING, - TSDataType.BLOB, - TSDataType.TIMESTAMP, - TSDataType.DATE, - ], - max_row_num, - ) - for i in range(max_row_num): - tablet.add_timestamp(i, i) - tablet.add_value_by_name("Device1", i, "d1_" + str(i)) - tablet.add_value_by_name("Device2", i, "d2_" + str(i)) - tablet.add_value_by_name("Value1", i, i % 2 == 0) - tablet.add_value_by_name("Value2", i, i * 3) - tablet.add_value_by_name("Value3", i, i * 4) - tablet.add_value_by_name("Value4", i, i * 5.5) - tablet.add_value_by_name("Value5", i, i * 6.6) - tablet.add_value_by_name("Value6", i, f"string_value_{i}") - tablet.add_value_by_name("Value7", i, f"text_value_{i}") - tablet.add_value_by_name("Value8", i, f"blob_data_{i}".encode('utf-8')) - tablet.add_value_by_name("Value9", i, i * 9) - tablet.add_value_by_name("Value10", i, date(2025, 1, i % 20 + 1)) - dateSet.add(date(2025, 1, i % 20 + 1)) - writer.write_table(tablet) - - df1_1 = to_dataframe(tsfile_path) - assert df1_1.shape[0] == max_row_num - for i in range(max_row_num): - assert df1_1.iloc[i, 1] == "d1_" + str(df1_1.iloc[i, 0]) - assert df1_1.iloc[i, 2] == "d2_" + str(df1_1.iloc[i, 0]) - - df2_1 = to_dataframe(tsfile_path, column_names=["Value1"]) - for i in range(max_row_num): - assert df2_1.iloc[i, 1] == np.bool_(df2_1.iloc[i, 0] % 2 == 0) - df2_2 = to_dataframe(tsfile_path, column_names=["Value2"]) - for i in range(max_row_num): - assert df2_2.iloc[i, 1] == np.int32(df2_2.iloc[i, 0] * 3) - df2_3 = to_dataframe(tsfile_path, column_names=["Value3"]) - for i in range(max_row_num): - assert df2_3.iloc[i, 1] == np.int64(df2_3.iloc[i, 0] * 4) - df2_4 = to_dataframe(tsfile_path, column_names=["Value4"]) - for i in range(max_row_num): - assert df2_4.iloc[i, 1] == np.float32(df2_4.iloc[i, 0] * 5.5) - df2_5 = to_dataframe(tsfile_path, column_names=["Value5"]) - for i in range(max_row_num): - assert df2_5.iloc[i, 1] == np.float64(df2_5.iloc[i, 0] * 6.6) - df2_6 = to_dataframe(tsfile_path, column_names=["Value6"]) - for i in range(max_row_num): - assert df2_6.iloc[i, 1] == f"string_value_{df2_6.iloc[i, 0]}" - df2_7 = to_dataframe(tsfile_path, column_names=["Value7"]) - for i in range(max_row_num): - assert df2_7.iloc[i, 1] == f"text_value_{df2_7.iloc[i, 0]}" - df2_8 = to_dataframe(tsfile_path, column_names=["Value8"]) - for i in range(max_row_num): - assert df2_8.iloc[i, 1] == f"blob_data_{df2_8.iloc[i, 0]}".encode('utf-8') - df2_9 = to_dataframe(tsfile_path, column_names=["Value9"]) - for i in range(max_row_num): - assert df2_9.iloc[i, 1] == np.int64(df2_9.iloc[i, 0] * 9) - df2_10 = to_dataframe(tsfile_path, column_names=["Value10"]) - for i in range(max_row_num): - assert df2_10.iloc[i, 1] in dateSet - df2_11 = to_dataframe(tsfile_path, column_names=["Device1", "Value1"]) - for i in range(max_row_num): - assert df2_11.iloc[i, 1] == "d1_" + str(df2_11.iloc[i, 0]) - assert df2_11.iloc[i, 2] == np.bool_(df2_11.iloc[i, 0] % 2 == 0) - df2_12 = to_dataframe( - tsfile_path, - column_names=[ - "Device1", - "Device2", - "Value1", - "Value2", - "Value3", - "Value4", - "Value5", - "Value6", - "Value7", - "Value8", - "Value9", - "Value10", - ], - ) - for i in range(max_row_num): - assert df2_12.iloc[i, 1] == "d1_" + str(df2_12.iloc[i, 0]) - assert df2_12.iloc[i, 2] == "d2_" + str(df2_12.iloc[i, 0]) - assert df2_12.iloc[i, 3] == np.bool_(df2_12.iloc[i, 0] % 2 == 0) - assert df2_12.iloc[i, 4] == np.int32(df2_12.iloc[i, 0] * 3) - assert df2_12.iloc[i, 5] == np.int64(df2_12.iloc[i, 0] * 4) - assert df2_12.iloc[i, 6] == np.float32(df2_12.iloc[i, 0] * 5.5) - assert df2_12.iloc[i, 7] == np.float64(df2_12.iloc[i, 0] * 6.6) - assert df2_12.iloc[i, 8] == f"string_value_{df2_12.iloc[i, 0]}" - assert df2_12.iloc[i, 9] == f"text_value_{df2_12.iloc[i, 0]}" - assert df2_12.iloc[i, 10] == f"blob_data_{df2_12.iloc[i, 0]}".encode( - "utf-8" - ) - assert df2_12.iloc[i, 11] == np.int64(df2_12.iloc[i, 0] * 9) - assert df2_12.iloc[i, 12] == date(2025, 1, df2_12.iloc[i, 0] % 20 + 1) - df2_13 = to_dataframe( - tsfile_path, column_names=["Device1", "Device2", "Value1"] - ) - for i in range(max_row_num): - assert df2_13.iloc[i, 1] == "d1_" + str(df2_13.iloc[i, 0]) - assert df2_13.iloc[i, 2] == "d2_" + str(df2_13.iloc[i, 0]) - assert df2_13.iloc[i, 3] == np.bool_(df2_13.iloc[i, 0] % 2 == 0) - - df3_1 = to_dataframe(tsfile_path, table_name="test_table") - assert df3_1.shape[0] == max_row_num - assert df3_1.iloc[0, 0] == 0 - df3_2 = to_dataframe(tsfile_path, table_name="TEST_TABLE") - assert df3_2.shape[0] == max_row_num - assert df3_2.iloc[0, 0] == 0 - - df4_1 = to_dataframe(tsfile_path, start_time=10) - assert df4_1.shape[0] == 90 - df4_2 = to_dataframe(tsfile_path, start_time=-10) - assert df4_2.shape[0] == max_row_num - df4_3 = to_dataframe(tsfile_path, end_time=5) - assert df4_3.shape[0] == 6 - df4_4 = to_dataframe(tsfile_path, end_time=-5) - assert df4_4.shape[0] == 0 - df4_5 = to_dataframe(tsfile_path, start_time=5, end_time=5) - assert df4_5.shape[0] == 1 - df4_6 = to_dataframe(tsfile_path, start_time=-5, end_time=-5) - assert df4_6.shape[0] == 0 - df4_7 = to_dataframe(tsfile_path, start_time=10, end_time=-10) - assert df4_7.shape[0] == 0 - df4_8 = to_dataframe(tsfile_path, start_time=-10, end_time=10) - assert df4_8.shape[0] == 11 - df4_8 = to_dataframe(tsfile_path, start_time=-50, end_time=50) - assert df4_8.shape[0] == 51 - - df5_1 = to_dataframe(tsfile_path, max_row_num=1) - assert df5_1.shape[0] == 1 - df5_2 = to_dataframe(tsfile_path, max_row_num=50) - assert df5_2.shape[0] == 50 - df5_3 = to_dataframe(tsfile_path, max_row_num=100) - assert df5_3.shape[0] == 100 - df5_4 = to_dataframe(tsfile_path, max_row_num=1000) - assert df5_4.shape[0] == 100 - df5_5 = to_dataframe(tsfile_path, max_row_num=0) - assert df5_5.shape[0] == 0 - df5_6 = to_dataframe(tsfile_path, max_row_num=-10) - assert df5_6.shape[0] == 0 - - for df6_1 in to_dataframe(tsfile_path, max_row_num=20, as_iterator=True): - assert df6_1.shape[0] == 20 - for df6_2 in to_dataframe(tsfile_path, max_row_num=1000, as_iterator=True): - assert df6_2.shape[0] == 100 - - for df7_1 in to_dataframe( - tsfile_path, - table_name="test_table", - column_names=["Device1", "Value1"], - start_time=21, - end_time=50, - max_row_num=10, - as_iterator=True, - ): - assert df7_1.shape[0] == 10 - for i in range(30): - assert df2_11.iloc[i, 1] == "d1_" + str(df2_11.iloc[i, 0]) - assert df2_11.iloc[i, 2] == np.bool_(df2_11.iloc[i, 0] % 2 == 0) - - try: - to_dataframe(tsfile_path, table_name="non_existent_table") - except TableNotExistError as e: - assert e.args[0] == "[non_existent_table] Requested table does not exist" - - try: - to_dataframe(tsfile_path, column_names=["non_existent_column"]) - except ColumnNotExistError as e: - assert e.args[0] == "[non_existent_column] Column does not exist" - - finally: - if os.path.exists(tsfile_path): - os.remove(tsfile_path) - + if os.path.exists("tablet_write_and_read.tsfile"): + os.remove("tablet_write_and_read.tsfile") -import os if __name__ == "__main__": os.chdir(os.path.dirname(os.path.abspath(__file__))) diff --git a/python/tsfile/__init__.py b/python/tsfile/__init__.py index bf755fcef..a9237257b 100644 --- a/python/tsfile/__init__.py +++ b/python/tsfile/__init__.py @@ -34,4 +34,4 @@ from .tsfile_writer import TsFileWriterPy as TsFileWriter from .tsfile_py_cpp import get_tsfile_config, set_tsfile_config from .tsfile_table_writer import TsFileTableWriter -from .utils import to_dataframe \ No newline at end of file +from .utils import to_dataframe, dataframe_to_tsfile \ No newline at end of file diff --git a/python/tsfile/constants.py b/python/tsfile/constants.py index 7d1f5ff5c..6f233e271 100644 --- a/python/tsfile/constants.py +++ b/python/tsfile/constants.py @@ -15,8 +15,9 @@ # specific language governing permissions and limitations # under the License. # +from datetime import datetime from enum import unique, IntEnum - +import numpy as np @unique class TSDataType(IntEnum): @@ -31,6 +32,11 @@ class TSDataType(IntEnum): BLOB = 10 STRING = 11 + def is_compatible_with(self, other: 'TSDataType') -> bool: + if self == other: + return True + return other in _TSDATATYPE_COMPATIBLE_SOURCES.get(self, ()) + def to_py_type(self): if self == TSDataType.BOOLEAN: return bool @@ -62,20 +68,102 @@ def to_pandas_dtype(self): elif self == TSDataType.INT64: return "Int64" elif self == TSDataType.FLOAT: - return "float32" + return "Float32" elif self == TSDataType.DOUBLE: - return "float64" + return "Float64" elif self == TSDataType.TEXT or self == TSDataType.STRING: return "object" elif self == TSDataType.TIMESTAMP: - return "int64" + return "Int64" elif self == TSDataType.DATE: return "object" elif self == TSDataType.BLOB: - return "bytes" + return "object" else: raise ValueError(f"Unknown data type: {self}") + @classmethod + def from_pandas_datatype(cls, dtype): + if dtype is np.bool_: + return cls.BOOLEAN + elif dtype is np.int32: + return cls.INT32 + elif dtype is np.int64: + return cls.INT64 + elif dtype is np.float32: + return cls.FLOAT + elif dtype is np.float64: + return cls.DOUBLE + elif dtype is np.object_: + return cls.STRING + + try: + import pandas as pd + if hasattr(pd, 'StringDtype') and isinstance(dtype, pd.StringDtype): + return cls.STRING + except (ImportError, AttributeError): + pass + + if hasattr(dtype, 'type'): + dtype = dtype.type + if dtype is np.bool_: + return cls.BOOLEAN + elif dtype is np.int32: + return cls.INT32 + elif dtype is np.int64: + return cls.INT64 + elif dtype is np.float32: + return cls.FLOAT + elif dtype is np.float64: + return cls.DOUBLE + elif dtype is np.object_: + return cls.STRING + + dtype_str = str(dtype) + + if 'stringdtype' in dtype_str.lower() or dtype_str.startswith('string'): + return cls.STRING + + dtype_map = { + 'bool': cls.BOOLEAN, + 'boolean': cls.BOOLEAN, + 'int32': cls.INT32, + 'Int32': cls.INT32, + 'int64': cls.INT64, + 'Int64': cls.INT64, + 'float32': cls.FLOAT, + 'float64': cls.DOUBLE, + 'bytes': cls.BLOB, + 'object': cls.STRING, + 'string': cls.STRING, + } + + if dtype_str in dtype_map: + return dtype_map[dtype_str] + + dtype_lower = dtype_str.lower() + if dtype_lower in dtype_map: + return dtype_map[dtype_lower] + + if 'object_' in dtype_lower or dtype_str == "": + return cls.STRING + + if dtype_str.startswith('datetime64'): + return cls.TIMESTAMP + + return cls.STRING + + +_TSDATATYPE_COMPATIBLE_SOURCES = { + TSDataType.INT64: (TSDataType.INT32, TSDataType.TIMESTAMP), + TSDataType.STRING: (TSDataType.TEXT,), + TSDataType.TEXT: (TSDataType.STRING,), + TSDataType.DOUBLE: (TSDataType.FLOAT,), + TSDataType.TIMESTAMP: (TSDataType.INT64, TSDataType.INT32) +} + + + @unique class TSEncoding(IntEnum): @@ -112,3 +200,5 @@ class Compressor(IntEnum): class ColumnCategory(IntEnum): TAG = 0 FIELD = 1 + ATTRIBUTE = 2 + TIME = 3 diff --git a/python/tsfile/exceptions.py b/python/tsfile/exceptions.py index 2a3df283a..a02f392ce 100644 --- a/python/tsfile/exceptions.py +++ b/python/tsfile/exceptions.py @@ -23,7 +23,7 @@ class LibraryError(Exception): def __init__(self, code=None, context=None): self.code = code if code is not None else self._default_code self.message = context if context is not None else self._default_message - super().__init__(f"[{code}] {self.message}") + super().__init__(f"[{self.code}] {self.message}") def __str__(self): return f"{self.code}: {self.message}" diff --git a/python/tsfile/schema.py b/python/tsfile/schema.py index 3aa1313cd..91732eee3 100644 --- a/python/tsfile/schema.py +++ b/python/tsfile/schema.py @@ -17,6 +17,7 @@ # from typing import List +from .exceptions import TypeMismatchError from .constants import TSDataType, ColumnCategory, TSEncoding, Compressor @@ -53,7 +54,6 @@ def __repr__(self): return f"TimeseriesSchema({self.timeseries_name}, {self.data_type.name}, {self.encoding_type.name}, {self.compression_type.name})" - class DeviceSchema: """Represents a device entity containing multiple time series.""" @@ -73,6 +73,7 @@ def get_timeseries_list(self): def __repr__(self): return f"DeviceSchema({self.device_name}, {self.timeseries_list})" + class ColumnSchema: """Defines schema for a table column (name, datatype, category).""" @@ -85,6 +86,11 @@ def __init__(self, column_name: str, data_type: TSDataType, category: ColumnCate self.column_name = column_name.lower() if data_type is None: raise ValueError("Data type cannot be None") + if category == ColumnCategory.TIME and data_type not in [TSDataType.INT64, TSDataType.TIMESTAMP]: + raise TypeError(f"Time Column should have type : INT64/Timestamp," + f" but got {data_type}") + elif category == ColumnCategory.TAG and data_type not in [TSDataType.STRING, TSDataType.TEXT]: + raise TypeMismatchError(context="Tag column should be string or text") self.data_type = data_type self.category = category @@ -105,6 +111,7 @@ class TableSchema: """Schema definition for a table structure.""" table_name = None columns = None + time_column = None def __init__(self, table_name: str, columns: List[ColumnSchema]): if table_name is None or len(table_name) == 0: @@ -113,6 +120,14 @@ def __init__(self, table_name: str, columns: List[ColumnSchema]): if len(columns) == 0: raise ValueError("Columns cannot be empty") self.columns = columns + for column in self.columns: + if column.get_category() == ColumnCategory.TIME: + if self.time_column is not None: + raise ValueError( + f"Table '{self.table_name}' cannot have multiple time columns: " + f"'{self.time_column.name}' and '{column.name}'" + ) + self.time_column = column def get_table_name(self): return self.table_name @@ -120,9 +135,49 @@ def get_table_name(self): def get_columns(self): return self.columns + def get_column(self, column_name: str): + name_lower = column_name.lower() + for col in self.columns: + if col.get_column_name() == name_lower: + return col + return None + + def get_time_column(self): + return self.time_column + def get_column_names(self): return [name.get_column_name() for name in self.columns] + def get_field_columns(self): + return [ + column + for column in self.columns + if column.get_category() == ColumnCategory.FIELD + ] + + def get_tag_columns(self): + return [ + column + for column in self.columns + if column.get_category() == ColumnCategory.TAG + ] + + def add_column(self, column: ColumnSchema): + if column.get_category() == ColumnCategory.TIME: + if self.time_column is not None: + raise ValueError( + f"Table '{self.table_name}' cannot have multiple time columns: " + f"'{self.time_column.name}' and '{column.name}'" + ) + self.time_column = column + else: + for col in self.columns: + if col.get_column_name() == column.get_column_name(): + raise ValueError( + f"Duplicate column name {col.get_column_name()}" + ) + self.columns.append(column) + def __repr__(self) -> str: return f"TableSchema({self.table_name}, {self.columns})" diff --git a/python/tsfile/tsfile_cpp.pxd b/python/tsfile/tsfile_cpp.pxd index 40bff4eba..9c65fb26f 100644 --- a/python/tsfile/tsfile_cpp.pxd +++ b/python/tsfile/tsfile_cpp.pxd @@ -76,7 +76,10 @@ cdef extern from "./tsfile_cwrapper.h": ctypedef enum ColumnCategory: TAG = 0, - FIELD = 1 + FIELD = 1, + ATTRIBUTE = 2, + TIME = 3 + # struct types ctypedef struct ColumnSchema: @@ -137,7 +140,8 @@ cdef extern from "./tsfile_cwrapper.h": TSDataType * data_types, int column_num, int max_rows); - Tablet tablet_new(const char** column_names, TSDataType * data_types, int column_num); + Tablet tablet_new(char** column_name_list, TSDataType* data_types, + uint32_t column_num, uint32_t max_rows); ErrorCode tablet_add_timestamp(Tablet tablet, uint32_t row_index, int64_t timestamp); ErrorCode tablet_add_value_by_index_int64_t(Tablet tablet, uint32_t row_index, uint32_t column_index, diff --git a/python/tsfile/tsfile_py_cpp.pxd b/python/tsfile/tsfile_py_cpp.pxd index e44bb588d..2389aa9a6 100644 --- a/python/tsfile/tsfile_py_cpp.pxd +++ b/python/tsfile/tsfile_py_cpp.pxd @@ -33,6 +33,7 @@ cdef public api DeviceSchema* to_c_device_schema(object py_schema) cdef public api ColumnSchema* to_c_column_schema(object py_schema) cdef public api TableSchema* to_c_table_schema(object py_schema) cdef public api Tablet to_c_tablet(object tablet) +cdef public api Tablet dataframe_to_c_tablet(object target_name, object dataframe, object table_schema) cdef public api TsRecord to_c_record(object row_record) cdef public api void free_c_table_schema(TableSchema* c_schema) cdef public api void free_c_column_schema(ColumnSchema* c_schema) diff --git a/python/tsfile/tsfile_py_cpp.pyx b/python/tsfile/tsfile_py_cpp.pyx index d9924d7ad..3ca79a2a1 100644 --- a/python/tsfile/tsfile_py_cpp.pyx +++ b/python/tsfile/tsfile_py_cpp.pyx @@ -16,9 +16,13 @@ # under the License. # #cython: language_level=3 +from datetime import date as date_type from .date_utils import parse_date_to_int from .tsfile_cpp cimport * +import pandas as pd +import numpy as np + from libc.stdlib cimport free from libc.stdlib cimport malloc from libc.string cimport strdup @@ -26,7 +30,7 @@ from cpython.exc cimport PyErr_SetObject from cpython.unicode cimport PyUnicode_AsUTF8String, PyUnicode_AsUTF8, PyUnicode_AsUTF8AndSize from cpython.bytes cimport PyBytes_AsString, PyBytes_AsStringAndSize -from tsfile.exceptions import ERROR_MAPPING +from tsfile.exceptions import ERROR_MAPPING, TypeMismatchError from tsfile.schema import ResultSetMetaData as ResultSetMetaDataPy from tsfile.schema import TSDataType as TSDataTypePy, TSEncoding as TSEncodingPy from tsfile.schema import Compressor as CompressorPy, ColumnCategory as CategoryPy @@ -130,7 +134,9 @@ cdef dict COMPRESSION_TYPE_MAP = { cdef dict CATEGORY_MAP = { CategoryPy.TAG: ColumnCategory.TAG, - CategoryPy.FIELD: ColumnCategory.FIELD + CategoryPy.FIELD: ColumnCategory.FIELD, + CategoryPy.ATTRIBUTE: ColumnCategory.ATTRIBUTE, + CategoryPy.TIME: ColumnCategory.TIME } cdef TSDataType to_c_data_type(object data_type): @@ -220,7 +226,7 @@ cdef Tablet to_c_tablet(object tablet): cdef TSDataType * column_types cdef bytes row_bytes cdef char *raw_str - cdef const char* str_ptr + cdef const char * str_ptr cdef Py_ssize_t raw_len if tablet.get_target_name() is not None: @@ -293,7 +299,7 @@ cdef Tablet to_c_tablet(object tablet): for row in range(max_row_num): if value[row] is not None: py_value = value[row] - str_ptr = PyUnicode_AsUTF8AndSize(py_value, &raw_len) + str_ptr = PyUnicode_AsUTF8AndSize(py_value, &raw_len) tablet_add_value_by_index_string_with_len(ctablet, row, col, str_ptr, raw_len) elif data_type == TS_DATATYPE_BLOB: @@ -304,13 +310,172 @@ cdef Tablet to_c_tablet(object tablet): return ctablet +cdef Tablet dataframe_to_c_tablet(object target_name, object dataframe, object table_schema): + cdef Tablet ctablet + cdef int max_row_num + cdef TSDataType data_type + cdef int64_t timestamp + cdef const char * device_id_c = NULL + cdef char** columns_names + cdef TSDataType * columns_types + cdef char *raw_str + cdef const char * str_ptr + cdef Py_ssize_t raw_len + cdef int column_num + cdef int i, row + cdef object value + cdef object py_value + cdef object value_bytes + + device_id_bytes = PyUnicode_AsUTF8String(target_name.lower()) + device_id_c = device_id_bytes + df_columns = list(dataframe.columns) + use_id_as_time = False + + time_column = table_schema.get_time_column() + use_id_as_time = time_column is None + time_column_name = None if time_column is None else time_column.get_column_name() + + data_columns = [col for col in df_columns if col != time_column_name] + column_num = len(data_columns) + + if column_num == 0: + raise ValueError("DataFrame must have at least one data column besides 'time'") + + max_row_num = len(dataframe) + + column_types_list = [] + for column in data_columns: + data_type = table_schema.get_column(column).get_data_type() + column_types_list.append(data_type) + + columns_names = malloc(sizeof(char *) * column_num) + columns_types = malloc(sizeof(TSDataType) * column_num) + + for i in range(column_num): + columns_names[i] = strdup(data_columns[i].lower().encode('utf-8')) + columns_types[i] = column_types_list[i] + + ctablet = _tablet_new_with_target_name(device_id_c, columns_names, columns_types, column_num, + max_row_num) + + free(columns_types) + for i in range(column_num): + free(columns_names[i]) + free(columns_names) + + if use_id_as_time: + for row in range(max_row_num): + timestamp_py = dataframe.index[row] + if pd.isna(timestamp_py): + continue + timestamp = timestamp_py + tablet_add_timestamp(ctablet, row, timestamp) + else: + time_values = dataframe[time_column.get_column_name()].values + for row in range(max_row_num): + timestamp_py = time_values[row] + if pd.isna(timestamp_py): + continue + timestamp = timestamp_py + tablet_add_timestamp(ctablet, row, timestamp) + + for col in range(column_num): + col_name = data_columns[col] + data_type = column_types_list[col] + column_values = dataframe[col_name].values + + # Per-column validation for object types (check first non-null value only) + if data_type in (TS_DATATYPE_DATE, TS_DATATYPE_STRING, TS_DATATYPE_TEXT, TS_DATATYPE_BLOB): + col_series = dataframe[col_name] + first_valid_idx = col_series.first_valid_index() + if first_valid_idx is not None: + value = col_series[first_valid_idx] + if data_type == TS_DATATYPE_DATE: + if not isinstance(value, date_type): + raise TypeMismatchError(context= + f"Column '{col_name}': expected DATE (datetime.date), " + f"got {type(value).__name__}: {value!r}" + ) + elif data_type in (TS_DATATYPE_STRING, TS_DATATYPE_TEXT): + if not isinstance(value, str): + raise TypeMismatchError(context= + f"Column '{col_name}': expected STRING/TEXT, " + f"got {type(value).__name__}: {value!r}" + ) + elif data_type == TS_DATATYPE_BLOB: + if not isinstance(value, bytes): + raise TypeMismatchError(context= + f"Column '{col_name}': expected BLOB (bytes or bytearray), " + f"got {type(value).__name__}: {value!r}" + ) + + # BOOLEAN + if data_type == TS_DATATYPE_BOOLEAN: + for row in range(max_row_num): + value = column_values[row] + if not pd.isna(value): + tablet_add_value_by_index_bool(ctablet, row, col, value) + # INT32 + elif data_type == TS_DATATYPE_INT32: + for row in range(max_row_num): + value = column_values[row] + if not pd.isna(value): + tablet_add_value_by_index_int32_t(ctablet, row, col, value) + # INT64 + elif data_type == TS_DATATYPE_INT64 or data_type == TS_DATATYPE_TIMESTAMP: + for row in range(max_row_num): + value = column_values[row] + if not pd.isna(value): + tablet_add_value_by_index_int64_t(ctablet, row, col, value) + # FLOAT + elif data_type == TS_DATATYPE_FLOAT: + for row in range(max_row_num): + value = column_values[row] + if not pd.isna(value): + tablet_add_value_by_index_float(ctablet, row, col, value) + # DOUBLE + elif data_type == TS_DATATYPE_DOUBLE: + for row in range(max_row_num): + value = column_values[row] + if not pd.isna(value): + tablet_add_value_by_index_double(ctablet, row, col, value) + # DATE (validated per-column above) + elif data_type == TS_DATATYPE_DATE: + for row in range(max_row_num): + value = column_values[row] + if not pd.isna(value): + tablet_add_value_by_index_int32_t(ctablet, row, col, parse_date_to_int(value)) + # STRING or TEXT (validated per-column above) + elif data_type == TS_DATATYPE_STRING or data_type == TS_DATATYPE_TEXT: + for row in range(max_row_num): + value = column_values[row] + if not pd.isna(value): + py_value = str(value) + str_ptr = PyUnicode_AsUTF8AndSize(py_value, &raw_len) + tablet_add_value_by_index_string_with_len(ctablet, row, col, str_ptr, raw_len) + # BLOB (validated per-column above) + elif data_type == TS_DATATYPE_BLOB: + for row in range(max_row_num): + value = column_values[row] + if not pd.isna(value): + if isinstance(value, bytes): + PyBytes_AsStringAndSize(value, &raw_str, &raw_len) + tablet_add_value_by_index_string_with_len(ctablet, row, col, raw_str, raw_len) + else: + value_bytes = bytes(value) + PyBytes_AsStringAndSize(value_bytes, &raw_str, &raw_len) + tablet_add_value_by_index_string_with_len(ctablet, row, col, raw_str, raw_len) + + return ctablet + cdef TsRecord to_c_record(object row_record): cdef int field_num = row_record.get_fields_num() cdef int64_t timestamp = row_record.get_timestamp() cdef bytes device_id_bytes = PyUnicode_AsUTF8String(row_record.get_device_id()) - cdef const char* device_id = device_id_bytes - cdef const char* str_ptr - cdef char* blob_ptr + cdef const char * device_id = device_id_bytes + cdef const char * str_ptr + cdef char * blob_ptr cdef Py_ssize_t str_len cdef TsRecord record cdef int i @@ -320,9 +485,11 @@ cdef TsRecord to_c_record(object row_record): field = row_record.get_fields()[i] data_type = to_c_data_type(field.get_data_type()) if data_type == TS_DATATYPE_BOOLEAN: - _insert_data_into_ts_record_by_name_bool(record, PyUnicode_AsUTF8(field.get_field_name()), field.get_bool_value()) + _insert_data_into_ts_record_by_name_bool(record, PyUnicode_AsUTF8(field.get_field_name()), + field.get_bool_value()) elif data_type == TS_DATATYPE_INT32 or data_type == TS_DATATYPE_DATE: - _insert_data_into_ts_record_by_name_int32_t(record, PyUnicode_AsUTF8(field.get_field_name()), field.get_int_value()) + _insert_data_into_ts_record_by_name_int32_t(record, PyUnicode_AsUTF8(field.get_field_name()), + field.get_int_value()) elif data_type == TS_DATATYPE_INT64: _insert_data_into_ts_record_by_name_int64_t(record, PyUnicode_AsUTF8(field.get_field_name()), field.get_long_value()) @@ -333,15 +500,17 @@ cdef TsRecord to_c_record(object row_record): _insert_data_into_ts_record_by_name_double(record, PyUnicode_AsUTF8(field.get_field_name()), field.get_double_value()) elif data_type == TS_DATATYPE_FLOAT: - _insert_data_into_ts_record_by_name_float(record, PyUnicode_AsUTF8(field.get_field_name()), field.get_float_value()) + _insert_data_into_ts_record_by_name_float(record, PyUnicode_AsUTF8(field.get_field_name()), + field.get_float_value()) elif data_type == TS_DATATYPE_TEXT or data_type == TS_DATATYPE_STRING: - str_ptr = PyUnicode_AsUTF8AndSize(field.get_string_value(), &str_len) - _insert_data_into_ts_record_by_name_string_with_len(record, PyUnicode_AsUTF8(field.get_field_name()), str_ptr, str_len) + str_ptr = PyUnicode_AsUTF8AndSize(field.get_string_value(), &str_len) + _insert_data_into_ts_record_by_name_string_with_len(record, PyUnicode_AsUTF8(field.get_field_name()), + str_ptr, str_len) elif data_type == TS_DATATYPE_BLOB: if PyBytes_AsStringAndSize(field.get_string_value(), &blob_ptr, &str_len) < 0: raise ValueError("blob not legal") _insert_data_into_ts_record_by_name_string_with_len(record, PyUnicode_AsUTF8(field.get_field_name()), - blob_ptr, str_len) + blob_ptr, str_len) return record # Free c structs' space diff --git a/python/tsfile/tsfile_reader.pyx b/python/tsfile/tsfile_reader.pyx index 359492d6f..041764f91 100644 --- a/python/tsfile/tsfile_reader.pyx +++ b/python/tsfile/tsfile_reader.pyx @@ -24,6 +24,8 @@ from typing import List import pandas as pd from libc.stdint cimport INT64_MIN, INT64_MAX +from libc.string cimport strlen +from cpython.bytes cimport PyBytes_FromStringAndSize from tsfile.schema import TSDataType as TSDataTypePy from .date_utils import parse_int_to_date @@ -166,7 +168,7 @@ cdef class ResultSetPy: return tsfile_result_set_get_value_by_index_double(self.result, index) elif data_type == TSDataTypePy.BOOLEAN: return tsfile_result_set_get_value_by_index_bool(self.result, index) - elif data_type == TSDataTypePy.STRING or data_type == TSDataTypePy.TEXT or data_type == TSDataTypePy.BLOB: + elif data_type == TSDataTypePy.STRING or data_type == TSDataTypePy.TEXT: try: string = tsfile_result_set_get_value_by_index_string(self.result, index) if string == NULL: @@ -174,6 +176,14 @@ cdef class ResultSetPy: return string.decode('utf-8') finally: pass + elif data_type == TSDataTypePy.BLOB: + try: + string = tsfile_result_set_get_value_by_index_string(self.result, index) + if string == NULL: + return None + return PyBytes_FromStringAndSize(string, strlen(string)) + finally: + pass def get_value_by_name(self, column_name : str): """ diff --git a/python/tsfile/tsfile_table_writer.py b/python/tsfile/tsfile_table_writer.py index 281933606..0346fd522 100644 --- a/python/tsfile/tsfile_table_writer.py +++ b/python/tsfile/tsfile_table_writer.py @@ -15,9 +15,63 @@ # specific language governing permissions and limitations # under the License. # +from datetime import date, datetime -from tsfile import TableSchema, Tablet, TableNotExistError -from tsfile import TsFileWriter +import pandas as pd + +from tsfile import TableSchema, Tablet, TableNotExistError, ColumnCategory +from tsfile import TsFileWriter, ColumnSchema +from tsfile.constants import TSDataType +from tsfile.exceptions import TypeMismatchError, ColumnNotExistError + + +def validate_dataframe_for_tsfile(df: pd.DataFrame) -> None: + if df is None or df.empty: + raise ValueError("DataFrame cannot be None or empty") + + columns = list(df.columns) + + seen = set() + duplicates = [] + for c in columns: + lower = c.lower() + if lower in seen: + duplicates.append(c) + seen.add(lower) + if duplicates: + raise ValueError( + f"Column names must be unique (case-insensitive). Duplicate columns: {duplicates}" + ) + + unsupported = [] + for col in columns: + dtype = df[col].dtype + try: + TSDataType.from_pandas_datatype(dtype) + except (ValueError, TypeError) as e: + unsupported.append((col, str(dtype), str(e))) + + if unsupported: + msg_parts = [f" - {col}: dtype={dtype}" for col, dtype in unsupported] + raise ValueError( + "Data types not supported by tsfile:\n" + "\n".join(msg_parts) + ) + + +def infer_object_column_type(column_series: pd.Series) -> TSDataType: + first_valid_idx = column_series.first_valid_index() + if first_valid_idx is None: + return TSDataType.STRING + value = column_series[first_valid_idx] + if isinstance(value, (bytes, bytearray)): + return TSDataType.BLOB + if isinstance(value, (date, datetime)): + return TSDataType.DATE + if isinstance(value, str): + return TSDataType.STRING + raise TypeError( + f"Cannot infer type from object column: expected str/bytes/date, got {type(value).__name__}: {value!r}" + ) class TsFileTableWriter: @@ -39,7 +93,7 @@ def __init__(self, path: str, table_schema: TableSchema, memory_threshold = 128 """ self.writer = TsFileWriter(path, memory_threshold) self.writer.register_table(table_schema) - self.exclusive_table_name_ = table_schema.get_table_name() + self.tableSchema = table_schema def write_table(self, tablet: Tablet): """ @@ -49,11 +103,81 @@ def write_table(self, tablet: Tablet): :raise: TableNotExistError if table does not exist or tablet's table_name does not match tableschema. """ if tablet.get_target_name() is None: - tablet.set_table_name(self.exclusive_table_name_) - elif self.exclusive_table_name_ is not None and tablet.get_target_name() != self.exclusive_table_name_: + tablet.set_table_name(self.tableSchema.get_table_name()) + elif (self.tableSchema.get_table_name() is not None + and tablet.get_target_name() != self.tableSchema.get_table_name()): raise TableNotExistError self.writer.write_table(tablet) + def write_dataframe(self, dataframe: pd.DataFrame): + """ + Write a pandas DataFrame into table in tsfile. + :param dataframe: pandas DataFrame with 'time' column and data columns matching schema. + :return: no return value. + :raise: ValueError if dataframe is None or is empty. + :raise: ColumnNotExistError if DataFrame columns don't match schema. + :raise: TypeMismatchError if DataFrame column types are incompatible with schema. + """ + + validate_dataframe_for_tsfile(dataframe) + + # rename columns to lowercase + dataframe = dataframe.rename(columns=str.lower) + time_column = self.tableSchema.get_time_column() + # tag columns used for sorting + tag_columns = self.tableSchema.get_tag_columns() + if time_column is None: + if 'time' in dataframe.columns: + dtype = TSDataType.from_pandas_datatype(dataframe['time'].dtype) + if not TSDataType.TIMESTAMP.is_compatible_with(dtype): + raise TypeMismatchError( + code=27, + context=f"time column require INT/Timestamp" + ) + + self.tableSchema.add_column(ColumnSchema("time", + TSDataType.TIMESTAMP, + ColumnCategory.TIME)) + time_column = self.tableSchema.get_time_column() + + type_mismatches = [] + for col_name in dataframe.columns: + if time_column is not None and col_name == time_column.get_column_name(): + continue + schema_col = self.tableSchema.get_column(col_name) + if schema_col is None: + raise ColumnNotExistError(context=f"{col_name} is not define in table schema") + # Object dtype can represent STRING, DATE, TEXT, BLOB; validation will be performed during insert, skip here + if schema_col.get_data_type() in [TSDataType.INT64, TSDataType.INT32, TSDataType.DOUBLE, TSDataType.FLOAT, + TSDataType.BOOLEAN, TSDataType.TIMESTAMP]: + df_dtype = dataframe[col_name].dtype + df_ts_type = TSDataType.from_pandas_datatype(df_dtype) + expected_ts_type = schema_col.get_data_type() + + if not expected_ts_type.is_compatible_with(df_ts_type): + type_mismatches.append( + f"Column '{col_name}': expected {expected_ts_type.name}, got {df_ts_type.name}" + ) + + if type_mismatches: + raise TypeMismatchError( + code=27, + context=f"Type mismatches: {'; '.join(type_mismatches)}" + ) + + if time_column: + time_column_name = time_column.get_column_name() + time_series = dataframe[time_column_name] + if time_series.isna().any(): + raise ValueError( + f"Time column '{time_column}' must not contain null/NaN values" + ) + sort_by = [column.get_column_name() for column in tag_columns] + sort_by.append(time_column_name) + dataframe = dataframe.sort_values(by=sort_by) + + self.writer.write_dataframe(self.tableSchema.get_table_name(), dataframe, self.tableSchema) + def close(self): """ Close TsFileTableWriter and will flush data automatically. diff --git a/python/tsfile/tsfile_writer.pyx b/python/tsfile/tsfile_writer.pyx index 201991952..4826ef72d 100644 --- a/python/tsfile/tsfile_writer.pyx +++ b/python/tsfile/tsfile_writer.pyx @@ -15,21 +15,21 @@ # specific language governing permissions and limitations # under the License. # - -#cython: language_level=3 - -from .tsfile_cpp cimport * -from .tsfile_py_cpp cimport * +import pandas from tsfile.row_record import RowRecord -from tsfile.schema import TimeseriesSchema as TimeseriesSchemaPy, DeviceSchema as DeviceSchemaPy from tsfile.schema import TableSchema as TableSchemaPy +from tsfile.schema import TimeseriesSchema as TimeseriesSchemaPy, DeviceSchema as DeviceSchemaPy from tsfile.tablet import Tablet as TabletPy +from .tsfile_cpp cimport * +from .tsfile_py_cpp cimport * + +#cython: language_level=3 cdef class TsFileWriterPy: cdef TsFileWriter writer - def __init__(self, pathname:str, memory_threshold:int = 128 * 1024 * 1024): + def __init__(self, pathname: str, memory_threshold: int = 128 * 1024 * 1024): self.writer = tsfile_writer_new_c(pathname, memory_threshold) def register_timeseries(self, device_name : str, timeseries_schema : TimeseriesSchemaPy): @@ -38,7 +38,7 @@ cdef class TsFileWriterPy: device_name: device name of the timeseries timeseries_schema: measurement's name/datatype/encoding/compressor """ - cdef TimeseriesSchema* c_schema = to_c_timeseries_schema(timeseries_schema) + cdef TimeseriesSchema * c_schema = to_c_timeseries_schema(timeseries_schema) cdef ErrorCode errno try: errno = tsfile_writer_register_timeseries_py_cpp(self.writer, device_name, c_schema) @@ -51,7 +51,7 @@ cdef class TsFileWriterPy: Register a device with tsfile writer. device_schema: the device definition, including device_name, some measurements' schema. """ - cdef DeviceSchema* device_schema_c = to_c_device_schema(device_schema) + cdef DeviceSchema * device_schema_c = to_c_device_schema(device_schema) cdef ErrorCode errno try: errno = tsfile_writer_register_device_py_cpp(self.writer, device_schema_c) @@ -64,7 +64,7 @@ cdef class TsFileWriterPy: Register a table with tsfile writer. table_schema: the table definition, include table_name, columns' schema. """ - cdef TableSchema* c_schema = to_c_table_schema(table_schema) + cdef TableSchema * c_schema = to_c_table_schema(table_schema) cdef ErrorCode errno try: errno = tsfile_writer_register_table_py_cpp(self.writer, c_schema) @@ -86,6 +86,15 @@ cdef class TsFileWriterPy: finally: free_c_tablet(ctablet) + def write_dataframe(self, target_table: str, dataframe: pandas.DataFrame, tableschema: TableSchemaPy): + cdef Tablet ctablet = dataframe_to_c_tablet(target_table, dataframe, tableschema) + cdef ErrorCode errno + try: + errno = _tsfile_writer_write_table(self.writer, ctablet) + check_error(errno) + finally: + free_c_tablet(ctablet) + def write_row_record(self, record : RowRecord): """ Write a record into tsfile with tsfile writer. @@ -143,4 +152,3 @@ cdef class TsFileWriterPy: def __exit__(self, exc_type, exc_val, exc_tb): self.close() - diff --git a/python/tsfile/utils.py b/python/tsfile/utils.py index d27a0fae3..71e213462 100644 --- a/python/tsfile/utils.py +++ b/python/tsfile/utils.py @@ -20,9 +20,12 @@ import numpy as np import pandas as pd +from pandas.core.dtypes.common import is_integer_dtype, is_object_dtype +from tsfile import ColumnSchema, TableSchema, ColumnCategory, TSDataType from tsfile.exceptions import TableNotExistError, ColumnNotExistError from tsfile.tsfile_reader import TsFileReaderPy +from tsfile.tsfile_table_writer import TsFileTableWriter, infer_object_column_type, validate_dataframe_for_tsfile def to_dataframe(file_path: str, @@ -159,3 +162,98 @@ def _gen(is_iterator: bool) -> Iterator[pd.DataFrame]: return df else: return pd.DataFrame() + + +def dataframe_to_tsfile(dataframe: pd.DataFrame, + file_path: str, + table_name: Optional[str] = None, + time_column: Optional[str] = None, + tag_column: Optional[list[str]] = None, + ): + """ + Write a pandas DataFrame to a TsFile by inferring the table schema from the DataFrame. + + This function automatically infers the table schema based on the DataFrame's column + names and data types, then writes the data to a TsFile. + + Parameters + ---------- + dataframe : pd.DataFrame + The pandas DataFrame to write to TsFile. + - If a 'time' column (case-insensitive) exists, it will be used as the time column. + - Otherwise, the DataFrame index will be used as timestamps. + - All other columns will be treated as data columns. + + file_path : str + Path to the TsFile to write. Will be created if it doesn't exist. + + table_name : Optional[str], default None + Name of the table. If None, defaults to "default_table". + + time_column : Optional[str], default None + Name of the time column. If None, will look for a column named 'time' (case-insensitive), + or use the DataFrame index if no 'time' column is found. + + tag_column : Optional[list[str]], default None + List of column names to be treated as TAG columns. All other columns will be FIELD columns. + If None, all columns are treated as FIELD columns. + + Returns + ------- + None + + Raises + ------ + ValueError + If the DataFrame is empty or has no data columns. + """ + validate_dataframe_for_tsfile(dataframe) + df = dataframe.rename(columns=str.lower) + + if not table_name: + table_name = "default_table" + + if time_column is not None: + if time_column.lower() not in df.columns: + raise ValueError(f"Time column '{time_column}' not found in DataFrame") + if tag_column is not None: + for tag_col in tag_column: + if tag_col.lower() not in df.columns: + raise ValueError(f"Tag column '{tag_col}' not found in DataFrame") + tag_columns_lower = {t.lower() for t in (tag_column or [])} + + if time_column is not None: + time_col_name = time_column.lower() + elif 'time' in df.columns: + time_col_name = 'time' + else: + time_col_name = None + + if time_col_name is not None: + if not is_integer_dtype(df[time_col_name].dtype): + raise TypeError( + f"Time column '{time_col_name}' must be integer type (int64 or int), got {df[time_col_name].dtype}") + + column_schemas = [] + if time_col_name is not None: + column_schemas.append(ColumnSchema(time_col_name, TSDataType.TIMESTAMP, ColumnCategory.TIME)) + + for col in df.columns: + if col == time_col_name: + continue + col_dtype = df[col].dtype + if is_object_dtype(col_dtype): + ts_data_type = infer_object_column_type(df[col]) + else: + ts_data_type = TSDataType.from_pandas_datatype(col_dtype) + + category = ColumnCategory.TAG if col in tag_columns_lower else ColumnCategory.FIELD + column_schemas.append(ColumnSchema(col, ts_data_type, category)) + + if len(column_schemas) == 0: + raise ValueError("DataFrame must have at least one data column besides the time column") + + table_schema = TableSchema(table_name, column_schemas) + + with TsFileTableWriter(file_path, table_schema) as writer: + writer.write_dataframe(df)