add comments.

cluster/src/shard_operator.rs

@@ -15,7 +15,6 @@ use snafu::ResultExt;
 use table_engine::{
     engine::{TableEngineRef, TableState},
     table::TableId,
-    ANALYTIC_ENGINE_TYPE,
 };
 
 use crate::{

cluster/src/shard_set.rs

@@ -13,8 +13,9 @@ use crate::{
     Result, ShardVersionMismatch, TableAlreadyExists, TableNotFound, UpdateFrozenShard,
 };
 
-/// [ShardTablesCache] caches the information about tables and shards, and the
-/// relationship between them is: one shard -> multiple tables.
+/// Shard set
+///
+/// Manage all shards opened on current node
 #[derive(Debug, Default, Clone)]
 pub struct ShardSet {
     inner: Arc<std::sync::RwLock<HashMap<ShardId, ShardRef>>>,
@@ -46,6 +47,9 @@ impl ShardSet {
     }
 }
 
+/// Shard
+///
+/// NOTICE: all write operations on a shard will be performed sequentially.
 pub struct Shard {
     pub data: ShardDataRef,
     pub operator: tokio::sync::Mutex<ShardOperator>,
@@ -113,19 +117,14 @@ impl Shard {
 
 pub type ShardRef = Arc<Shard>;
 
-#[derive(Debug, Clone)]
-pub struct TableWithShards {
-    pub table_info: TableInfo,
-    pub shard_infos: Vec<ShardInfo>,
-}
-
 #[derive(Debug, Clone)]
 pub struct UpdatedTableInfo {
     pub prev_version: u64,
     pub shard_info: ShardInfo,
     pub table_info: TableInfo,
 }
 
+/// Shard data
 #[derive(Debug)]
 pub struct ShardData {
     /// Shard info

server/src/grpc/meta_event_service/mod.rs

@@ -297,7 +297,7 @@ async fn do_open_shard(ctx: HandlerContext, shard_info: ShardInfo) -> Result<()>
 
     shard.open(open_ctx).await.box_err().context(ErrWithCause {
         code: StatusCode::Internal,
-        msg: "fail to open shard in cluster",
+        msg: "fail to open shard",
     })
 }
 
@@ -346,7 +346,7 @@ async fn do_close_shard(ctx: &HandlerContext, shard_id: ShardId) -> Result<()> {
         .box_err()
         .context(ErrWithCause {
             code: StatusCode::Internal,
-            msg: "fail to close shard in cluster",
+            msg: "fail to close shard",
         })?;
 
     // Remove the shard from the cluster topology after the shard is closed indeed.
@@ -434,7 +434,7 @@ async fn handle_create_table_on_shard(
         .box_err()
         .context(ErrWithCause {
             code: StatusCode::Internal,
-            msg: "fail to create table on shard in cluster",
+            msg: "fail to create table on shard",
         })
 }
 
@@ -470,7 +470,7 @@ async fn handle_drop_table_on_shard(
         .box_err()
         .context(ErrWithCause {
             code: StatusCode::Internal,
-            msg: "fail to drop table on shard in cluster",
+            msg: "fail to drop table on shard",
         })
 }
 
@@ -503,7 +503,7 @@ async fn handle_open_table_on_shard(
         .box_err()
         .context(ErrWithCause {
             code: StatusCode::Internal,
-            msg: "fail to open table on shard in cluster",
+            msg: "fail to open table on shard",
         })
 }
 
@@ -537,7 +537,7 @@ async fn handle_close_table_on_shard(
         .box_err()
         .context(ErrWithCause {
             code: StatusCode::Internal,
-            msg: "fail to close table on shard in cluster",
+            msg: "fail to close table on shard",
         })
 }