From 3610e9ea16a3606c79962c6c497f3f1fb90fffc6 Mon Sep 17 00:00:00 2001
From: Zhenchi <zhongzc_arch@outlook.com>
Date: Thu, 23 Nov 2023 11:05:19 +0000
Subject: [PATCH] chore: rename fields to reduce confused

Signed-off-by: Zhenchi <zhongzc_arch@outlook.com>
---
 proto/greptime/v1/index/inverted_index.proto | 25 ++++++++------------
 1 file changed, 10 insertions(+), 15 deletions(-)

diff --git a/proto/greptime/v1/index/inverted_index.proto b/proto/greptime/v1/index/inverted_index.proto
index 9f050d84..0be7c301 100644
--- a/proto/greptime/v1/index/inverted_index.proto
+++ b/proto/greptime/v1/index/inverted_index.proto
@@ -35,22 +35,21 @@ message InvertedIndexMeta {
 
     // The base byte offset for this tag's inverted index data within the blob.
     // Other offsets in this message are relative to this base offset.
-    uint64 offset = 2;
+    uint64 base_offset = 2;
 
     // The total size in bytes of this tag's inverted index data, including bitmaps,
     // FST data.
-    uint64 size = 3;
+    uint64 inverted_index_size = 3;
 
-    // The byte offset of the Finite State Transducer (FST) relative to the base
-    // 'offset'.
-    uint32 fst_offset = 4;
+    // The byte offset of the Finite State Transducer (FST) data relative to the `base_offset`.
+    uint32 relative_fst_offset = 4;
 
     // The size in bytes of the FST data.
     uint32 fst_size = 5;
 
-    // The byte offset relative to the base 'offset' where the null bitmap for this tag
+    // The byte offset relative to the `base_offset` where the null bitmap for this tag
     // starts.
-    uint32 null_bitmap_offset = 6;
+    uint32 relative_null_bitmap_offset = 6;
 
     // The size in bytes of the null bitmap.
     uint32 null_bitmap_size = 7;
@@ -58,14 +57,10 @@ message InvertedIndexMeta {
     // Statistical information about the tag's inverted index.
     InvertedIndexStats stats = 8;
 
-    // Defines the number of rows per group for bitmap indexing. It determines how rows
-    // are batched for indexing, with each batch corresponding to a segment in the bitmap.
-    // The groups are usually of uniform size, with the exception of the final group which
-    // may contain fewer rows if the total row count is not a multiple of 'row_count_in_group'.
-    // Segmenting allows indexed values in the tag column to be quickly located within
-    // their respective groups during a query, reducing the search space and improving
-    // retrieval efficiency.
-    uint64 row_count_in_group = 9;
+    // The number of rows per group for bitmap indexing which determines how rows are
+    // batched for indexing. Each batch corresponds to a segment in the bitmap and allows
+    // for efficient retrieval during queries by reducing the search space.
+    uint64 segment_row_count = 9;
 }
 
 // InvertedIndexStats provides statistical data on a tag's inverted index.