add comments to example

Author: manlge

README.md

@@ -64,6 +64,7 @@ iotdb-client-rs="0.3.3"
 chrono="0.4.19"
 prettytable-rs="0.8.0"
 ```
+## Example
 
 ```rust
 use std::vec;
@@ -77,7 +78,7 @@ use iotdb_client_rs::protocal::{TSCompressionType, TSDataType, TSEncoding};
 use prettytable::{cell, Row, Table};
 
 fn main() {
-    run().expect("failed to run session_example.")
+    run().expect("failed to run session_example.");
 }
 
 fn run() -> Result<()> {
@@ -90,15 +91,28 @@ fn run() -> Result<()> {
     };
     let mut session = RpcSession::new(&config)?;
     session.open()?;
+
+    //time_zone
     let tz = session.get_time_zone()?;
     if tz != "Asia/Shanghai" {
         session.set_time_zone("Asia/Shanghai")?;
     }
+
+    //set_storage_group
     session.set_storage_group("root.ln1")?;
     session.delete_storage_group("root.ln1")?;
+
+    //delete_storage_groups
     session.set_storage_group("root.ln1")?;
     session.set_storage_group("root.ln2")?;
     session.delete_storage_groups(vec!["root.ln1", "root.ln2"])?;
+
+    //if storage group 'root.sg_rs' exist remove it.
+    // session
+    //     .delete_storage_group("root.sg_rs")
+    //     .unwrap_or_default();
+
+    //create_timeseries
     session.create_timeseries(
         "root.sg_rs.dev2.status",
         TSDataType::Float,
@@ -110,6 +124,21 @@ fn run() -> Result<()> {
         None,
     )?;
     session.delete_timeseries(vec!["root.sg_rs.dev2.status"])?;
+
+    //create_multi_timeseries
+    session.create_multi_timeseries(
+        vec!["root.sg3.dev1.temperature", "root.sg3.dev1.desc"],
+        vec![TSDataType::Float, TSDataType::Text],
+        vec![TSEncoding::Plain, TSEncoding::Plain],
+        vec![TSCompressionType::SNAPPY, TSCompressionType::SNAPPY],
+        None,
+        None,
+        None,
+        None,
+    )?;
+    session.delete_timeseries(vec!["root.sg3.dev1.temperature", "root.sg3.dev1.desc"])?;
+
+    //insert_record
     session.insert_record(
         "root.sg_rs.dev5",
         vec!["online", "desc"],
@@ -118,6 +147,21 @@ fn run() -> Result<()> {
         false,
     )?;
     session.delete_timeseries(vec!["root.sg_rs.dev5.online", "root.sg_rs.dev5.desc"])?;
+
+    //insert_string_record
+    session.insert_string_record(
+        "root.sg_rs.wf02.wt02",
+        vec!["id", "location"],
+        vec!["SN:001", "BeiJing"],
+        Local::now().timestamp_millis(),
+        false,
+    )?;
+    session.delete_timeseries(vec![
+        "root.sg_rs.wf02.wt02.id",
+        "root.sg_rs.wf02.wt02.location",
+    ])?;
+
+    //insert_records
     session.insert_records(
         vec!["root.sg_rs.dev1"],
         vec![vec![
@@ -146,28 +190,8 @@ fn run() -> Result<()> {
         "root.sg_rs.dev1.description",
         "root.sg_rs.dev1.status",
     ])?;
-    session.create_multi_timeseries(
-        vec!["root.sg3.dev1.temperature", "root.sg3.dev1.desc"],
-        vec![TSDataType::Float, TSDataType::Text],
-        vec![TSEncoding::Plain, TSEncoding::Plain],
-        vec![TSCompressionType::SNAPPY, TSCompressionType::SNAPPY],
-        None,
-        None,
-        None,
-        None,
-    )?;
-    session.delete_timeseries(vec!["root.sg3.dev1.temperature", "root.sg3.dev1.desc"])?;
-    session.insert_string_record(
-        "root.sg_rs.wf02.wt02",
-        vec!["id", "location"],
-        vec!["SN:001", "BeiJing"],
-        Local::now().timestamp_millis(),
-        false,
-    )?;
-    session.delete_timeseries(vec![
-        "root.sg_rs.wf02.wt02.id",
-        "root.sg_rs.wf02.wt02.location",
-    ])?;
+
+    //insert_records_of_one_device
     session.insert_records_of_one_device(
         "root.sg_rs.dev0",
         vec![
@@ -188,6 +212,8 @@ fn run() -> Result<()> {
         ],
         false,
     )?;
+
+    //table
     let mut ts = Local::now().timestamp_millis();
     let mut tablet1 = create_tablet(5, ts);
     tablet1.sort();
@@ -196,9 +222,13 @@ fn run() -> Result<()> {
     ts += 10;
     let mut tablet3 = create_tablet(2, ts);
     tablet1.sort();
+
+    //insert_tablet
     session.insert_tablet(&tablet1)?;
     tablet2.sort();
     tablet3.sort();
+
+    //insert_tablets
     session.insert_tablets(vec![&tablet2, &tablet3])?;
     session.insert_records_of_one_device(
         "root.sg_rs.dev1",
@@ -207,8 +237,37 @@ fn run() -> Result<()> {
         vec![vec![Value::Bool(true)], vec![Value::Bool(true)]],
         true,
     )?;
+
+    //delete_data
     session.delete_data(vec!["root.sg_rs.dev1.status"], 1, 16)?;
+
+    //execute_query_statement
     let dataset = session.execute_query_statement("select * from root.sg_rs.device2", None)?;
+    // Get columns, column types and values from the data set
+    // For example:
+    // dataset
+    //     .get_column_names()
+    //     .iter()
+    //     .for_each(|c| print!("{}\t", c));
+    // print!("\n");
+    // dataset
+    //     .get_data_types()
+    //     .iter()
+    //     .for_each(|c| print!("{:?}\t", c));
+    // print!("\n");
+    // dataset.for_each(|r| {
+    //     r.values.iter().for_each(|v| match v {
+    //         Value::Bool(v) => print!("{}\t", v),
+    //         Value::Int32(v) => print!("{}\t", v),
+    //         Value::Int64(v) => print!("{}\t", v),
+    //         Value::Float(v) => print!("{}\t", v),
+    //         Value::Double(v) => print!("{}\t", v),
+    //         Value::Text(v) => print!("{}\t", v),
+    //         Value::Null => print!("null\t"),
+    //     });
+    //     print!("\n");
+    // });
+
     let mut table = Table::new();
     table.set_titles(Row::new(
         dataset
@@ -223,6 +282,8 @@ fn run() -> Result<()> {
         ));
     });
     table.printstd();
+
+    //execute_statement
     let dataset = session.execute_statement("show timeseries", None)?;
     let mut table = Table::new();
     table.set_titles(Row::new(
@@ -238,11 +299,15 @@ fn run() -> Result<()> {
         ));
     });
     table.printstd();
+
+    //execute_batch_statement
     session.execute_batch_statement(vec![
         "insert into root.sg_rs.dev6(time,s5) values(1,true)",
         "insert into root.sg_rs.dev6(time,s5) values(2,true)",
         "insert into root.sg_rs.dev6(time,s5) values(3,true)",
     ])?;
+
+    //execute_raw_data_query
     let dataset = session.execute_raw_data_query(
         vec![
             "root.sg_rs.device2.restart_count",
@@ -266,6 +331,8 @@ fn run() -> Result<()> {
         ));
     });
     table.printstd();
+
+    //execute_update_statement
     if let Some(dataset) =
         session.execute_update_statement("delete timeseries root.sg_rs.dev1.*")?
     {