Add a dedicated option to control inclusion of the indexImplTable boundaries in the main table description

Should help minimizing the network traffic and IO CPU pool load.

Author: jepett0

ydb/core/grpc_services/rpc_describe_table.cpp

@@ -205,10 +205,13 @@ class TDescribeTableRPC : public TRpcSchemeRequestActor<TDescribeTableRPC, TEvDe
         SetDatabase(navigateRequest.get(), *Request_);
         NKikimrSchemeOp::TDescribePath* record = navigateRequest->Record.MutableDescribePath();
         record->SetPath(path);
+
         if (req->include_shard_key_bounds()) {
             record->MutableOptions()->SetReturnBoundaries(true);
         }
-
+        if (req->include_index_table_shard_key_bounds()) {
+            record->MutableOptions()->SetReturnIndexTableBoundaries(true);
+        }
         if (req->include_partition_stats() && req->include_table_stats()) {
             record->MutableOptions()->SetReturnPartitionStats(true);
         }

ydb/core/protos/flat_scheme_op.proto

@@ -1832,6 +1832,7 @@ message TDescribeOptions {
     optional bool ReturnChannelsBinding = 8 [default = false];
     optional bool ReturnRangeKey = 9 [default = true];
     optional bool ReturnSetVal = 10 [default = false];
+    optional bool ReturnIndexTableBoundaries = 11 [default = false];
 }
 
 // Request to read scheme for a specific path

ydb/core/tx/schemeshard/schemeshard_export_flow_proposals.cpp

@@ -76,6 +76,7 @@ static NKikimrSchemeOp::TPathDescription GetTableDescription(TSchemeShard* ss, c
     opts.SetReturnPartitioningInfo(false);
     opts.SetReturnPartitionConfig(true);
     opts.SetReturnBoundaries(true);
+    opts.SetReturnIndexTableBoundaries(true);
 
     auto desc = DescribePath(ss, TlsActivationContext->AsActorContext(), pathId, opts);
     auto record = desc->GetRecord();

ydb/core/tx/schemeshard/schemeshard_path_describer.cpp

@@ -375,6 +375,7 @@ void TPathDescriber::DescribeTable(const TActorContext& ctx, TPathId pathId, TPa
     bool returnBoundaries = false;
     bool returnRangeKey = true;
     bool returnSetVal = Params.GetOptions().GetReturnSetVal();
+    bool returnIndexTableBoundaries = Params.GetOptions().GetReturnIndexTableBoundaries();
     if (Params.HasOptions()) {
         returnConfig = Params.GetOptions().GetReturnPartitionConfig();
         returnPartitioning = Params.GetOptions().GetReturnPartitioningInfo();
@@ -499,7 +500,9 @@ void TPathDescriber::DescribeTable(const TActorContext& ctx, TPathId pathId, TPa
 
         switch (childPath->PathType) {
         case NKikimrSchemeOp::EPathTypeTableIndex:
-            Self->DescribeTableIndex(childPathId, childName, returnConfig, returnBoundaries, *entry->AddTableIndexes());
+            Self->DescribeTableIndex(
+                childPathId, childName, returnConfig, returnIndexTableBoundaries, *entry->AddTableIndexes()
+            );
             break;
         case NKikimrSchemeOp::EPathTypeCdcStream:
             Self->DescribeCdcStream(childPathId, childName, *entry->AddCdcStreams());

ydb/library/backup/backup.cpp

@@ -373,7 +373,9 @@ NTable::TTableDescription DescribeTable(TDriver driver, const TString& fullTable
     NTable::TTableClient client(driver);
 
     TStatus status = client.RetryOperationSync([fullTablePath, &desc](NTable::TSession session) {
-        auto settings = NTable::TDescribeTableSettings().WithKeyShardBoundary(true);
+        auto settings = NTable::TDescribeTableSettings()
+            .WithKeyShardBoundary(true)
+            .WithIndexTableKeyShardBoundary(true);
         auto result = session.DescribeTable(fullTablePath, settings).GetValueSync();
 
         VerifyStatus(result);

ydb/public/api/protos/ydb_table.proto

@@ -72,7 +72,7 @@ message VectorIndexSettings {
         SIMILARITY_UNSPECIFIED = 0;
         SIMILARITY_COSINE = 1;
         SIMILARITY_INNER_PRODUCT = 2;
-    }   
+    }
 
     enum VectorType {
         VECTOR_TYPE_UNSPECIFIED = 0;
@@ -773,12 +773,16 @@ message DescribeTableRequest {
     // Full path
     string path = 2;
     Ydb.Operations.OperationParams operation_params = 4;
-    // Includes shard key distribution info
+    // Includes partition boundaries (the key values where the partitions are split)
     bool include_shard_key_bounds = 5;
     // Includes table statistics
     bool include_table_stats = 6;
     // Includes partition statistics (required include_table_statistics)
     bool include_partition_stats = 7;
+    // Note: The following flag applies only if the described table has indices.
+    // Includes partition boundaries (the key values where the partitions are split)
+    // for tables that implement indices of the described table.
+    bool include_index_table_shard_key_bounds = 8;
 }
 
 message DescribeTableResponse {

ydb/public/sdk/cpp/client/ydb_table/impl/table_client.cpp

@@ -513,14 +513,16 @@ TAsyncDescribeTableResult TTableClient::TImpl::DescribeTable(const TString& sess
     auto request = MakeOperationRequest<Ydb::Table::DescribeTableRequest>(settings);
     request.set_session_id(sessionId);
     request.set_path(path);
+
     if (settings.WithKeyShardBoundary_) {
         request.set_include_shard_key_bounds(true);
     }
-
+    if (settings.WithIndexTableKeyShardBoundary_) {
+        request.set_include_index_table_shard_key_bounds(true);
+    }
     if (settings.WithTableStatistics_) {
         request.set_include_table_stats(true);
     }
-
     if (settings.WithPartitionStatistics_) {
         request.set_include_partition_stats(true);
     }

ydb/public/sdk/cpp/client/ydb_table/table.h

@@ -174,10 +174,10 @@ struct TExplicitPartitions {
     using TSelf = TExplicitPartitions;
 
     FLUENT_SETTING_VECTOR(TValue, SplitPoints);
-    
+
     template <typename TProto>
     static TExplicitPartitions FromProto(const TProto& proto);
-    
+
     void SerializeTo(Ydb::Table::ExplicitPartitions& proto) const;
 };
 
@@ -1625,6 +1625,7 @@ struct TRenameTablesSettings : public TOperationRequestSettings<TRenameTablesSet
 
 struct TDescribeTableSettings : public TOperationRequestSettings<TDescribeTableSettings> {
     FLUENT_SETTING_DEFAULT(bool, WithKeyShardBoundary, false);
+    FLUENT_SETTING_DEFAULT(bool, WithIndexTableKeyShardBoundary, false);
     FLUENT_SETTING_DEFAULT(bool, WithTableStatistics, false);
     FLUENT_SETTING_DEFAULT(bool, WithPartitionStatistics, false);
 };