You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@doris.apache.org by da...@apache.org on 2024/04/17 13:27:59 UTC

(doris) 02/15: [chore](cloud) Fix some comment format for critical KV layout (#33623)

This is an automated email from the ASF dual-hosted git repository.

dataroaring pushed a commit to branch branch-4.0-preview
in repository https://gitbox.apache.org/repos/asf/doris.git

commit b67173fbe3971e84450e8d32ebe12428a1169116
Author: Gavin Chou <ga...@gmail.com>
AuthorDate: Tue Apr 16 09:17:28 2024 +0800

    [chore](cloud) Fix some comment format for critical KV layout (#33623)
---
 cloud/src/meta-service/keys.cpp | 86 ++++++++++++++++++++---------------------
 cloud/src/meta-service/keys.h   | 60 ++++++++++++++--------------
 2 files changed, 74 insertions(+), 72 deletions(-)

diff --git a/cloud/src/meta-service/keys.cpp b/cloud/src/meta-service/keys.cpp
index 01b4b990652..820d349084e 100644
--- a/cloud/src/meta-service/keys.cpp
+++ b/cloud/src/meta-service/keys.cpp
@@ -23,49 +23,49 @@ namespace doris::cloud {
 
 // clang-format off
 // Prefix
-[[maybe_unused]] static const char* INSTANCE_KEY_PREFIX = "instance";
+static const char* INSTANCE_KEY_PREFIX = "instance";
 
-[[maybe_unused]] static const char* TXN_KEY_PREFIX      = "txn";
-[[maybe_unused]] static const char* VERSION_KEY_PREFIX  = "version";
-[[maybe_unused]] static const char* META_KEY_PREFIX     = "meta";
-[[maybe_unused]] static const char* RECYCLE_KEY_PREFIX  = "recycle";
-[[maybe_unused]] static const char* STATS_KEY_PREFIX    = "stats";
-[[maybe_unused]] static const char* JOB_KEY_PREFIX      = "job";
-[[maybe_unused]] static const char* COPY_KEY_PREFIX     = "copy";
+static const char* TXN_KEY_PREFIX      = "txn";
+static const char* VERSION_KEY_PREFIX  = "version";
+static const char* META_KEY_PREFIX     = "meta";
+static const char* RECYCLE_KEY_PREFIX  = "recycle";
+static const char* STATS_KEY_PREFIX    = "stats";
+static const char* JOB_KEY_PREFIX      = "job";
+static const char* COPY_KEY_PREFIX     = "copy";
+static const char* VAULT_KEY_PREFIX    = "storage_vault";
 
 // Infix
-[[maybe_unused]] static const char* TXN_KEY_INFIX_LABEL       = "txn_label";
-[[maybe_unused]] static const char* TXN_KEY_INFIX_INFO        = "txn_info";
-[[maybe_unused]] static const char* TXN_KEY_INFIX_INDEX       = "txn_index";
-[[maybe_unused]] static const char* TXN_KEY_INFIX_RUNNING     = "txn_running";
-
-[[maybe_unused]] static const char* PARTITION_VERSION_KEY_INFIX      = "partition";
-[[maybe_unused]] static const char* TABLE_VERSION_KEY_INFIX   = "table";
-
-[[maybe_unused]] static const char* META_KEY_INFIX_ROWSET     = "rowset";
-[[maybe_unused]] static const char* META_KEY_INFIX_ROWSET_TMP = "rowset_tmp";
-[[maybe_unused]] static const char* META_KEY_INFIX_TABLET     = "tablet";
-[[maybe_unused]] static const char* META_KEY_INFIX_TABLET_IDX = "tablet_index";
-[[maybe_unused]] static const char* META_KEY_INFIX_SCHEMA     = "schema";
-[[maybe_unused]] static const char* META_KEY_INFIX_DELETE_BITMAP = "delete_bitmap";
-[[maybe_unused]] static const char* META_KEY_INFIX_DELETE_BITMAP_LOCK = "delete_bitmap_lock";
-[[maybe_unused]] static const char* META_KEY_INFIX_DELETE_BITMAP_PENDING = "delete_bitmap_pending";
-[[maybe_unused]] static const char* META_KEY_SCHEMA_PB_DICTIONARY = "tablet_schema_pb_dict";
-
-[[maybe_unused]] static const char* RECYCLE_KEY_INFIX_INDEX   = "index";
-[[maybe_unused]] static const char* RECYCLE_KEY_INFIX_PART    = "partition";
-[[maybe_unused]] static const char* RECYCLE_KEY_TXN           = "txn";
-
-[[maybe_unused]] static const char* STATS_KEY_INFIX_TABLET    = "tablet";
-
-[[maybe_unused]] static const char* JOB_KEY_INFIX_TABLET      = "tablet";
-[[maybe_unused]] static const char* JOB_KEY_INFIX_RL_PROGRESS = "routine_load_progress";
-
-[[maybe_unused]] static const char* COPY_JOB_KEY_INFIX        = "job";
-[[maybe_unused]] static const char* COPY_FILE_KEY_INFIX       = "loading_file";
-[[maybe_unused]] static const char* STAGE_KEY_INFIX           = "stage";
-[[maybe_unused]] static const char* VAULT_KEY_PREFIX          = "storage_vault";
-[[maybe_unused]] static const char* VAULT_KEY_INFIX           = "vault";
+static const char* TXN_KEY_INFIX_LABEL                  = "txn_label";
+static const char* TXN_KEY_INFIX_INFO                   = "txn_info";
+static const char* TXN_KEY_INFIX_INDEX                  = "txn_index";
+static const char* TXN_KEY_INFIX_RUNNING                = "txn_running";
+
+static const char* PARTITION_VERSION_KEY_INFIX          = "partition";
+static const char* TABLE_VERSION_KEY_INFIX              = "table";
+
+static const char* META_KEY_INFIX_ROWSET                = "rowset";
+static const char* META_KEY_INFIX_ROWSET_TMP            = "rowset_tmp";
+static const char* META_KEY_INFIX_TABLET                = "tablet";
+static const char* META_KEY_INFIX_TABLET_IDX            = "tablet_index";
+static const char* META_KEY_INFIX_SCHEMA                = "schema";
+static const char* META_KEY_INFIX_DELETE_BITMAP         = "delete_bitmap";
+static const char* META_KEY_INFIX_DELETE_BITMAP_LOCK    = "delete_bitmap_lock";
+static const char* META_KEY_INFIX_DELETE_BITMAP_PENDING = "delete_bitmap_pending";
+static const char* META_KEY_INFIX_SCHEMA_DICTIONARY     = "tablet_schema_pb_dict";
+
+static const char* RECYCLE_KEY_INFIX_INDEX              = "index";
+static const char* RECYCLE_KEY_INFIX_PART               = "partition";
+static const char* RECYCLE_KEY_TXN                      = "txn";
+
+static const char* STATS_KEY_INFIX_TABLET               = "tablet";
+
+static const char* JOB_KEY_INFIX_TABLET                 = "tablet";
+static const char* JOB_KEY_INFIX_RL_PROGRESS            = "routine_load_progress";
+
+static const char* COPY_JOB_KEY_INFIX                   = "job";
+static const char* COPY_FILE_KEY_INFIX                  = "loading_file";
+static const char* STAGE_KEY_INFIX                      = "stage";
+static const char* VAULT_KEY_INFIX                      = "vault";
 
 // clang-format on
 
@@ -306,9 +306,9 @@ void meta_pending_delete_bitmap_key(const MetaPendingDeleteBitmapInfo& in, std::
 }
 
 void meta_schema_pb_dictionary_key(const MetaSchemaPBDictionaryInfo& in, std::string* out) {
-    encode_prefix(in, out);                           // 0x01 "meta" ${instance_id}
-    encode_bytes(META_KEY_SCHEMA_PB_DICTIONARY, out); // "tablet_schema_pb_dict"
-    encode_int64(std::get<1>(in), out);               // index_id
+    encode_prefix(in, out);                              // 0x01 "meta" ${instance_id}
+    encode_bytes(META_KEY_INFIX_SCHEMA_DICTIONARY, out); // "tablet_schema_pb_dict"
+    encode_int64(std::get<1>(in), out);                  // index_id
 }
 
 //==============================================================================
diff --git a/cloud/src/meta-service/keys.h b/cloud/src/meta-service/keys.h
index 21cf2208de1..c63af925b8f 100644
--- a/cloud/src/meta-service/keys.h
+++ b/cloud/src/meta-service/keys.h
@@ -26,48 +26,50 @@
 // clang-format off
 // Key encoding schemes:
 //
-// 0x01 "instance" ${instance_id}                                                            -> InstanceInfoPB
+// 0x01 "instance" ${instance_id}                                               -> InstanceInfoPB
 //
-// 0x01 "txn" ${instance_id} "txn_label" ${db_id} ${label}                                   -> TxnLabelPB ${version_timestamp}
-// 0x01 "txn" ${instance_id} "txn_info" ${db_id} ${txn_id}                                   -> TxnInfoPB
-// 0x01 "txn" ${instance_id} "txn_db_tbl" ${txn_id}                                          -> TxnIndexPB
-// 0x01 "txn" ${instance_id} "txn_running" ${db_id} ${txn_id}                                -> TxnRunningPB
+// 0x01 "txn" ${instance_id} "txn_label" ${db_id} ${label}                      -> TxnLabelPB ${version_timestamp}
+// 0x01 "txn" ${instance_id} "txn_info" ${db_id} ${txn_id}                      -> TxnInfoPB
+// 0x01 "txn" ${instance_id} "txn_db_tbl" ${txn_id}                             -> TxnIndexPB
+// 0x01 "txn" ${instance_id} "txn_running" ${db_id} ${txn_id}                   -> TxnRunningPB
 //
-// 0x01 "version" ${instance_id} "partition" ${db_id} ${tbl_id} ${partition_id}              -> VersionPB
-// 0x01 "version" ${instance_id} "table" ${db_id} ${tbl_id}                                  -> int64
+// 0x01 "version" ${instance_id} "partition" ${db_id} ${tbl_id} ${partition_id} -> VersionPB
+// 0x01 "version" ${instance_id} "table" ${db_id} ${tbl_id}                     -> int64
 //
-// 0x01 "meta" ${instance_id} "rowset" ${tablet_id} ${version}                               -> RowsetMetaCloudPB
-// 0x01 "meta" ${instance_id} "rowset_tmp" ${txn_id} ${tablet_id}                            -> RowsetMetaCloudPB
-// 0x01 "meta" ${instance_id} "tablet" ${table_id} ${index_id} ${partition_id} ${tablet_id}  -> TabletMetaCloudPB
-// 0x01 "meta" ${instance_id} "tablet_index" ${tablet_id}                                    -> TabletIndexPB
-// 0x01 "meta" ${instance_id} "schema" ${index_id} ${schema_version}                         -> TabletSchemaCloudPB
-// 0x01 "meta" ${instance_id} "delete_bitmap_lock" ${table_id} ${partition_id}               -> DeleteBitmapUpdateLockPB
-// 0x01 "meta" ${instance_id} "delete_bitmap_pending" ${table_id}                            -> PendingDeleteBitmapPB 
+// 0x01 "meta" ${instance_id} "rowset" ${tablet_id} ${version}                                   -> RowsetMetaCloudPB
+// 0x01 "meta" ${instance_id} "rowset_tmp" ${txn_id} ${tablet_id}                                -> RowsetMetaCloudPB
+// 0x01 "meta" ${instance_id} "tablet" ${table_id} ${index_id} ${partition_id} ${tablet_id}      -> TabletMetaCloudPB
+// 0x01 "meta" ${instance_id} "tablet_index" ${tablet_id}                                        -> TabletIndexPB
+// 0x01 "meta" ${instance_id} "schema" ${index_id} ${schema_version}                             -> TabletSchemaCloudPB
+// 0x01 "meta" ${instance_id} "delete_bitmap_lock" ${table_id} ${partition_id}                   -> DeleteBitmapUpdateLockPB
+// 0x01 "meta" ${instance_id} "delete_bitmap_pending" ${table_id}                                -> PendingDeleteBitmapPB 
 // 0x01 "meta" ${instance_id} "delete_bitmap" ${tablet_id} ${rowset_id} ${version} ${segment_id} -> roaringbitmap
-// 0x01 "meta" ${instance_id} "tablet_schema_pb_dict" ${index_id}                            -> SchemaCloudDictionary
+// 0x01 "meta" ${instance_id} "tablet_schema_pb_dict" ${index_id}                                -> SchemaCloudDictionary
 //
-// 0x01 "stats" ${instance_id} "tablet" ${table_id} ${index_id} ${partition_id} ${tablet_id} -> TabletStatsPB
+// 0x01 "stats" ${instance_id} "tablet" ${table_id} ${index_id} ${partition_id} ${tablet_id}               -> TabletStatsPB
 // 0x01 "stats" ${instance_id} "tablet" ${table_id} ${index_id} ${partition_id} ${tablet_id} "data_size"   -> int64
 // 0x01 "stats" ${instance_id} "tablet" ${table_id} ${index_id} ${partition_id} ${tablet_id} "num_rows"    -> int64
 // 0x01 "stats" ${instance_id} "tablet" ${table_id} ${index_id} ${partition_id} ${tablet_id} "num_rowsets" -> int64
 // 0x01 "stats" ${instance_id} "tablet" ${table_id} ${index_id} ${partition_id} ${tablet_id} "num_segs"    -> int64
 //
-// 0x01 "recycle" ${instance_id} "index" ${index_id}                                         -> RecycleIndexPB
-// 0x01 "recycle" ${instance_id} "partition" ${partition_id}                                 -> RecyclePartitionPB
-// 0x01 "recycle" ${instance_id} "rowset" ${tablet_id} ${rowset_id}                          -> RecycleRowsetPB
-// 0x01 "recycle" ${instance_id} "txn" ${db_id} ${txn_id}                                    -> RecycleTxnPB
-// 0x01 "recycle" ${instance_id} "stage" ${stage_id}                                         -> RecycleStagePB
+// 0x01 "recycle" ${instance_id} "index" ${index_id}                                       -> RecycleIndexPB
+// 0x01 "recycle" ${instance_id} "partition" ${partition_id}                               -> RecyclePartitionPB
+// 0x01 "recycle" ${instance_id} "rowset" ${tablet_id} ${rowset_id}                        -> RecycleRowsetPB
+// 0x01 "recycle" ${instance_id} "txn" ${db_id} ${txn_id}                                  -> RecycleTxnPB
+// 0x01 "recycle" ${instance_id} "stage" ${stage_id}                                       -> RecycleStagePB
 //
-// 0x01 "job" ${instance_id} "tablet" ${table_id} ${index_id} ${partition_id} ${tablet_id}   -> TabletJobInfoPB
-// 0x01 "job" ${instance_id} "recycle"                                                       -> JobRecyclePB
-// 0x01 "job" ${instance_id} "check"                                                         -> JobRecyclePB
+// 0x01 "job" ${instance_id} "tablet" ${table_id} ${index_id} ${partition_id} ${tablet_id} -> TabletJobInfoPB
+// 0x01 "job" ${instance_id} "recycle"                                                     -> JobRecyclePB
+// 0x01 "job" ${instance_id} "check"                                                       -> JobRecyclePB
 //
-// 0x02 "system" "meta-service" "registry"                                                   -> MetaServiceRegistryPB
-// 0x02 "system" "meta-service" "arn_info"                                                   -> RamUserPB
-// 0x02 "system" "meta-service" "encryption_key_info"                                        -> EncryptionKeyInfoPB
+// 0x01 "copy" ${instance_id} "job" ${stage_id} ${table_id} ${copy_id} ${group_id}         -> CopyJobPB
+// 0x01 "copy" ${instance_id} "loading_file" ${stage_id} ${table_id} ${obj_name} ${etag}   -> CopyFilePB
 //
-// 0x01 "copy" ${instance_id} "job" ${stage_id} ${table_id} ${copy_id} ${group_id}           -> CopyJobPB
-// 0x01 "copy" ${instance_id} "loading_file" ${stage_id} ${table_id} ${obj_name} ${etag}    -> CopyFilePB
+// 0x01 "storage_vault" ${instance_id} "vault" ${resource_id}                              -> StorageVaultPB
+//
+// 0x02 "system" "meta-service" "registry"                                                 -> MetaServiceRegistryPB
+// 0x02 "system" "meta-service" "arn_info"                                                 -> RamUserPB
+// 0x02 "system" "meta-service" "encryption_key_info"                                      -> EncryptionKeyInfoPB
 // clang-format on
 
 namespace doris::cloud {


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org