|author||long.li <email@example.com>||Fri Dec 02 11:17:30 2022 +0800|
|committer||GitHub <firstname.lastname@example.org>||Fri Dec 02 11:17:30 2022 +0800|
add user guide (#7)
tsfile-viewer is a tool to view TSFILE. Currently, we support bit granularity parsing of TsFile and provide visual display.
we have three modules in the project
overview: This tool can Clearly display information of each part of TsFile, details are as follows:
The data layer: contains details of each level and statistic information.
The index layer: displayed in a tree like structure then you can easily view the overall structure of the secondary index(entity and measurement granularity).
Timeseries and measurement search: In addition to displaying data, we also provide the function of querying TimeSeries by keyword. There is a linkage between the index layer and the data layer, it can quickly locate the desired TimeSeries with details.
To use the tool, you need to have:
Of course, you will also notice that there is a front-end project in the project. When you execute the mvn install command, the project will download its corresponding environment, and you don't have to configure the environment separately for it.
You can download the source code from:
Under the root path of iotdb-tsfile-viewer:
mvn clean install
then you can start this tool in the tsfile-viewer-web project you can add ‘-Dfile.endoding=utf8’ command to avoid some Chinese garbled problems,mainly to solve the situation that some device names in the tsfile file contain Chinese
java -jar iotdb-tsfile-viewer-web-0.13.2-SNAPSHOT.jar java -Dfile.endoding=utf8 -jar iotdb-tsfile-viewer-web-0.13.2-SNAPSHOT.jar
The default url is
You can modify the port through the file
You can specify the parent folder location for tsfiles
tsfile-viewer-web\src\main\resources\application.yml tsviewer: web: baseDirectory: C:\Users\Administrator\Desktop\
When you visit http://locallhost:8080, you will get the following page.
The white blocks are clickable, when you click on them, their corresponding simple information will be displayed on the right.
You can get more infos by click the ‘more info’ block.
Click the page node to get pageData.
The TimeseriesIndexs is used similarly to ChunkGroups
Display the index structure in the form of a tree
Data Search function:
Feel free to dive in! Open an issue or submit PRs.
This project exists thanks to all the people who contribute.