Moved commit "Describe VIEW for YDB CLI" from ydb repo

Author: jepett0

include/ydb-cpp-sdk/client/draft/ydb_view.h

@@ -0,0 +1,62 @@
+#pragma once
+
+#include <ydb-cpp-sdk/client/driver/driver.h>
+#include <ydb-cpp-sdk/client/scheme/scheme.h>
+
+namespace Ydb::View {
+    class DescribeViewResult;
+}
+
+namespace NYdb {
+    class TProtoAccessor;
+}
+
+namespace NYql {
+    class TIssues;
+}
+
+namespace NYdb::NView {
+
+class TDescribeViewResult;
+using TAsyncDescribeViewResult = NThreading::TFuture<TDescribeViewResult>;
+
+struct TDescribeViewSettings : public TOperationRequestSettings<TDescribeViewSettings> {
+    using TSelf = TDescribeViewSettings;
+};
+
+class TViewDescription {
+public:
+    explicit TViewDescription(const Ydb::View::DescribeViewResult& desc);
+
+    const std::string& GetQueryText() const;
+
+private:
+    std::string QueryText_;
+};
+
+class TDescribeViewResult : public NScheme::TDescribePathResult {
+    friend class NYdb::TProtoAccessor;
+    const Ydb::View::DescribeViewResult& GetProto() const;
+
+public:
+    TDescribeViewResult(TStatus&& status, Ydb::View::DescribeViewResult&& desc);
+    TViewDescription GetViewDescription() const;
+
+private:
+    std::unique_ptr<Ydb::View::DescribeViewResult> Proto_;
+};
+
+class TViewClient {
+    class TImpl;
+
+public:
+    TViewClient(const TDriver& driver, const TCommonClientSettings& settings = TCommonClientSettings());
+
+    TAsyncDescribeViewResult DescribeView(const std::string& path,
+        const TDescribeViewSettings& settings = TDescribeViewSettings());
+
+private:
+    std::shared_ptr<TImpl> Impl_;
+};
+
+} // namespace NYdb::NView

include/ydb-cpp-sdk/client/proto/accessor.h

@@ -1,6 +1,7 @@
 #pragma once
 
 #include <src/api/protos/draft/ydb_replication.pb.h>
+#include <src/api/protos/draft/ydb_view.pb.h>
 #include <src/api/protos/ydb_coordination.pb.h>
 #include <src/api/protos/ydb_export.pb.h>
 #include <src/api/protos/ydb_import.pb.h>
@@ -10,6 +11,7 @@
 #include <src/api/protos/ydb_value.pb.h>
 
 #include <ydb-cpp-sdk/client/draft/ydb_replication.h>
+#include <ydb-cpp-sdk/client/draft/ydb_view.h>
 #include <ydb-cpp-sdk/client/coordination/coordination.h>
 #include <ydb-cpp-sdk/client/export/export.h>
 #include <ydb-cpp-sdk/client/import/import.h>
@@ -46,6 +48,7 @@ class TProtoAccessor {
     static const Ydb::Monitoring::SelfCheckResult& GetProto(const NYdb::NMonitoring::TSelfCheckResult& selfCheckResult);
     static const Ydb::Coordination::DescribeNodeResult& GetProto(const NYdb::NCoordination::TNodeDescription &describeNodeResult);
     static const Ydb::Replication::DescribeReplicationResult& GetProto(const NYdb::NReplication::TDescribeReplicationResult& desc);
+    static const Ydb::View::DescribeViewResult& GetProto(const NYdb::NView::TDescribeViewResult& desc);
 
     static NTable::TQueryStats FromProto(const Ydb::TableStats::QueryStats& queryStats);
     static NTable::TTableDescription FromProto(const Ydb::Table::CreateTableRequest& request);

src/api/grpc/draft/ydb_view_v1.proto

@@ -0,0 +1,10 @@
+syntax = "proto3";
+
+package Ydb.View.V1;
+option java_package = "com.yandex.ydb.view.v1";
+
+import "src/api/protos/draft/ydb_view.proto";
+
+service ViewService {
+    rpc DescribeView(View.DescribeViewRequest) returns (View.DescribeViewResponse);
+}

src/api/protos/draft/ydb_view.proto

@@ -0,0 +1,28 @@
+syntax = "proto3";
+option cc_enable_arenas = true;
+
+package Ydb.View;
+option java_package = "com.yandex.ydb.view";
+
+import "src/api/protos/annotations/validation.proto";
+import "src/api/protos/ydb_operation.proto";
+import "src/api/protos/ydb_scheme.proto";
+
+message DescribeViewRequest {
+    Ydb.Operations.OperationParams operation_params = 1;
+    // The path to the view.
+    string path = 2 [(required) = true];
+}
+
+message DescribeViewResponse {
+    // The result of the request will be inside the operation proto.
+    Ydb.Operations.Operation operation = 1;
+}
+
+message DescribeViewResult {
+    // Description of a generic scheme object.
+    Ydb.Scheme.Entry self = 1;
+
+    // View-specific fields.
+    string query_text = 2;
+}

src/client/draft/CMakeLists.txt

@@ -13,6 +13,7 @@ target_sources(client-draft PRIVATE
   ydb_dynamic_config.cpp
   ydb_replication.cpp
   ydb_scripting.cpp
+  ydb_view.cpp
 )
 
 generate_enum_serilization(client-draft

src/client/draft/ydb_view.cpp

@@ -0,0 +1,92 @@
+#include <ydb-cpp-sdk/client/draft/ydb_view.h>
+
+#define INCLUDE_YDB_INTERNAL_H
+#include <src/client/impl/ydb_internal/make_request/make.h>
+#undef INCLUDE_YDB_INTERNAL_H
+
+#include <src/api/grpc/draft/ydb_view_v1.grpc.pb.h>
+#include <src/api/protos/draft/ydb_view.pb.h>
+#include <src/client/common_client/impl/client.h>
+#include <ydb-cpp-sdk/client/proto/accessor.h>
+
+namespace NYdb {
+namespace NView {
+
+TViewDescription::TViewDescription(const Ydb::View::DescribeViewResult& desc)
+    : QueryText_(desc.query_text())
+{
+}
+
+const std::string& TViewDescription::GetQueryText() const {
+    return QueryText_;
+}
+
+TDescribeViewResult::TDescribeViewResult(TStatus&& status, Ydb::View::DescribeViewResult&& desc)
+    : NScheme::TDescribePathResult(std::move(status), desc.self())
+    , Proto_(std::make_unique<Ydb::View::DescribeViewResult>(std::move(desc)))
+{
+}
+
+TViewDescription TDescribeViewResult::GetViewDescription() const {
+    return TViewDescription(*Proto_);
+}
+
+const Ydb::View::DescribeViewResult& TDescribeViewResult::GetProto() const {
+    return *Proto_;
+}
+
+class TViewClient::TImpl : public TClientImplCommon<TViewClient::TImpl> {
+public:
+    TImpl(std::shared_ptr<TGRpcConnectionsImpl>&& connections, const TCommonClientSettings& settings)
+        : TClientImplCommon(std::move(connections), settings)
+    {
+    }
+
+    TAsyncDescribeViewResult DescribeView(const std::string& path, const TDescribeViewSettings& settings) {
+        using namespace Ydb::View;
+
+        auto request = MakeOperationRequest<DescribeViewRequest>(settings);
+        request.set_path(TStringType{path});
+
+        auto promise = NThreading::NewPromise<TDescribeViewResult>();
+
+        auto extractor = [promise]
+            (google::protobuf::Any* any, TPlainStatus status) mutable {
+                DescribeViewResult result;
+                if (any) {
+                    any->UnpackTo(&result);
+                }
+
+                TDescribeViewResult val(TStatus(std::move(status)), std::move(result));
+                promise.SetValue(std::move(val));
+            };
+
+        Connections_->RunDeferred<V1::ViewService, DescribeViewRequest, DescribeViewResponse>(
+            std::move(request),
+            extractor,
+            &V1::ViewService::Stub::AsyncDescribeView,
+            DbDriverState_,
+            INITIAL_DEFERRED_CALL_DELAY,
+            TRpcRequestSettings::Make(settings));
+
+        return promise.GetFuture();
+    }
+
+};
+
+TViewClient::TViewClient(const TDriver& driver, const TCommonClientSettings& settings)
+    : Impl_(std::make_shared<TImpl>(CreateInternalInterface(driver), settings))
+{
+}
+
+TAsyncDescribeViewResult TViewClient::DescribeView(const std::string& path, const TDescribeViewSettings& settings) {
+    return Impl_->DescribeView(path, settings);
+}
+
+} // NView
+
+const Ydb::View::DescribeViewResult& TProtoAccessor::GetProto(const NView::TDescribeViewResult& result) {
+    return result.GetProto();
+}
+
+} // NYdb

tests/unit/client/CMakeLists.txt

@@ -1,3 +1,5 @@
+add_subdirectory(draft/helpers)
+
 add_ydb_test(NAME client-ydb_coordination_ut
   SOURCES
     coordination/coordination_ut.cpp
@@ -22,6 +24,22 @@ add_ydb_test(NAME client-extensions-discovery_mutator_ut
     unit
 )
 
+add_ydb_test(NAME client-draft_ut
+  SOURCES
+    draft/ydb_scripting_response_headers_ut.cpp
+    draft/ydb_view_ut.cpp
+  LINK_LIBRARIES
+    yutil
+    cpp-testing-unittest_main
+    YDB-CPP-SDK::Draft
+  LABELS
+    unit
+)
+target_link_libraries(client-draft_ut
+  PRIVATE
+    client-draft_ut_helpers
+)
+
 add_ydb_test(NAME client-ydb_driver_ut
   SOURCES
     driver/driver_ut.cpp
@@ -99,14 +117,3 @@ add_ydb_test(NAME client-ydb_value_ut
   LABELS
     unit
 )
-
-add_ydb_test(NAME client-draft_ut
-  SOURCES
-    scripting/ydb_scripting_response_headers_ut.cpp
-  LINK_LIBRARIES
-    yutil
-    cpp-testing-unittest_main
-    YDB-CPP-SDK::Draft
-  LABELS
-    unit
-)

tests/unit/client/draft/helpers/CMakeLists.txt

@@ -0,0 +1,13 @@
+_ydb_sdk_add_library(client-draft_ut_helpers)
+
+target_link_libraries(client-draft_ut_helpers
+  PRIVATE
+    api-grpc
+    api-grpc-draft
+)
+
+target_sources(client-draft_ut_helpers
+  PRIVATE
+    grpc_services/scripting.cpp
+    grpc_services/view.cpp
+)

tests/unit/client/draft/helpers/grpc_server.h

@@ -0,0 +1,18 @@
+#pragma once
+
+#include <grpcpp/server.h>
+#include <grpcpp/server_builder.h>
+
+#include <ydb-cpp-sdk/type_switcher.h>
+
+namespace NYdb {
+
+template<class TService>
+std::unique_ptr<grpc::Server> StartGrpcServer(const std::string& address, TService& service) {
+    grpc::ServerBuilder builder;
+    builder.AddListeningPort(TStringType{address}, grpc::InsecureServerCredentials());
+    builder.RegisterService(&service);
+    return builder.BuildAndStart();
+}
+
+}

tests/unit/client/draft/helpers/grpc_services/scripting.cpp

@@ -0,0 +1,21 @@
+#include "scripting.h"
+
+namespace NYdb::NScripting {
+
+grpc::Status TMockSlyDbProxy::ExecuteYql(
+    grpc::ServerContext* context,
+    [[maybe_unused]] const Ydb::Scripting::ExecuteYqlRequest* request,
+    Ydb::Scripting::ExecuteYqlResponse* response
+) {
+    context->AddInitialMetadata("key", "value");
+
+    // Just to make sdk core happy
+    auto* op = response->mutable_operation();
+    op->set_ready(true);
+    op->set_status(Ydb::StatusIds::SUCCESS);
+    op->mutable_result();
+
+    return grpc::Status::OK;
+}
+
+}