Support QueryMeta and diagnostics (#11371)

Author: shnikd

include/ydb-cpp-sdk/client/query/stats.h

@@ -29,6 +29,7 @@ class TExecStats {
 
     std::optional<std::string> GetPlan() const;
     std::optional<std::string> GetAst() const;
+    std::optional<std::string> GetMeta() const;
 
     TDuration GetTotalDuration() const;
     TDuration GetTotalCpuTime() const;

include/ydb-cpp-sdk/client/table/query_stats/stats.h

@@ -30,7 +30,7 @@ namespace NTable {
 enum class ECollectQueryStatsMode {
     None = 0,  // Stats collection is disabled
     Basic = 1, // Aggregated stats of reads, updates and deletes per table
-    Full = 2,   // Add per-stage execution profile and query plan on top of Basic mode
+    Full = 2,   // Add per-stage execution profile, query plan and query meta on top of Basic mode
     Profile = 3   // Detailed execution stats including stats for individual tasks and channels
 };
 

include/ydb-cpp-sdk/client/table/table.h

@@ -1164,6 +1164,7 @@ struct TStreamExecScanQuerySettings : public TRequestSettings<TStreamExecScanQue
     // Collect runtime statistics with a given detalization mode
     FLUENT_SETTING_DEFAULT(ECollectQueryStatsMode, CollectQueryStats, ECollectQueryStatsMode::None);
 
+    // Deprecated. Use CollectQueryStats >= ECollectQueryStatsMode::Full to get QueryMeta in QueryStats
     // Collect full query compilation diagnostics
     FLUENT_SETTING_DEFAULT(bool, CollectFullDiagnostics, false);
 };
@@ -2109,6 +2110,7 @@ class TScanQueryPart : public TStreamPartStatus {
     const TQueryStats& GetQueryStats() const { return *QueryStats_; }
     TQueryStats ExtractQueryStats() { return std::move(*QueryStats_); }
 
+    // Deprecated. Use GetMeta() of TQueryStats
     bool HasDiagnostics() const { return Diagnostics_.has_value(); }
     const std::string& GetDiagnostics() const { return *Diagnostics_; }
     std::string&& ExtractDiagnostics() { return std::move(*Diagnostics_); }

src/api/protos/ydb_query_stats.proto

@@ -43,4 +43,7 @@ message QueryStats {
     string query_ast = 5;
     uint64 total_duration_us = 6;
     uint64 total_cpu_time_us = 7;
+    // will be filled only in MODE_EXPLAIN or in MODE_EXEC with QueryStatsCollection.Mode >= STATS_COLLECTION_FULL,
+    // collects additional meta about query compilation, including table metadata
+    string query_meta = 8;
 }

src/api/protos/ydb_table.proto

@@ -1274,7 +1274,7 @@ message ExecuteScanQueryRequest {
     QueryStatsCollection.Mode collect_stats = 8;
     // works only in mode: MODE_EXPLAIN,
     // collects additional diagnostics about query compilation, including query plan and scheme
-    bool collect_full_diagnostics = 9;
+    bool collect_full_diagnostics = 9 [deprecated=true];
 }
 
 message ExecuteScanQueryPartialResponse {
@@ -1292,7 +1292,7 @@ message ExecuteScanQueryPartialResult {
     Ydb.TableStats.QueryStats query_stats = 6;
     // works only in mode: MODE_EXPLAIN,
     // collects additional diagnostics about query compilation, including query plan and scheme
-    string query_full_diagnostics = 7;
+    string query_full_diagnostics = 7 [deprecated = true];
 }
 
 // Returns information about an external data source with a given path.

src/client/query/stats.cpp

@@ -31,6 +31,7 @@ std::string TExecStats::ToString(bool withPlan) const {
     if (!withPlan) {
         proto.clear_query_plan();
         proto.clear_query_ast();
+        proto.clear_query_meta();
     }
 
     TStringType res;
@@ -58,6 +59,16 @@ std::optional<std::string> TExecStats::GetAst() const {
     return proto.query_ast();
 }
 
+std::optional<std::string> TExecStats::GetMeta() const {
+    auto proto = Impl_->Proto;
+
+    if (proto.query_meta().empty()) {
+        return {};
+    }
+
+    return proto.query_meta();
+}
+
 TDuration TExecStats::GetTotalDuration() const {
     return TDuration::MicroSeconds(Impl_->Proto.total_duration_us());
 }