ydb/yt/yql/plugin/bridge/interface.h

#pragma once

#include <unistd.h>

////////////////////////////////////////////////////////////////////////////////

// This is a plain C version of an interface described in yt/yql/plugin/plugin.h.
// All strings without separate length field are assumed to be null-terminated.

////////////////////////////////////////////////////////////////////////////////

// NB(mpereskokova): don't forget to update min_required_abi_version at yt/yql/agent/config.cpp and abi_version in yt/yql/plugin/dynamic/impl.cpp during breaking changes
using TFuncBridgeGetAbiVersion = ssize_t();

////////////////////////////////////////////////////////////////////////////////

struct TBridgeYqlPluginOptions
{
    const char* SingletonsConfig = nullptr;
    ssize_t SingletonsConfigLength = 0;

    const char* GatewayConfig = nullptr;
    size_t GatewayConfigLength = 0;

    const char* FileStorageConfig = nullptr;
    size_t FileStorageConfigLength = 0;

    const char* OperationAttributes = nullptr;
    size_t OperationAttributesLength = 0;

    const char* YTTokenPath = nullptr;

    // TODO(max42): passing C++ objects across shared libraries is incredibly
    // fragile. This is a temporary mean until we come up with something more
    // convenient; get rid of this ASAP.
    using TLogBackendHolder = void;
    TLogBackendHolder* LogBackend = nullptr;
};

// Opaque type representing a YQL plugin.
using TBridgeYqlPlugin = void;

using TFuncBridgeCreateYqlPlugin = TBridgeYqlPlugin*(const TBridgeYqlPluginOptions* options);
using TFuncBridgeFreeYqlPlugin = void(TBridgeYqlPlugin* plugin);

////////////////////////////////////////////////////////////////////////////////

// TODO(max42): consider making structure an opaque type with accessors a-la
// const char* BridgeGetYsonResult(const TBridgeQueryResult*). This would remove the need
// to manually free string data.
struct TBridgeQueryResult
{
    const char* YsonResult = nullptr;
    ssize_t YsonResultLength = 0;
    const char* Plan = nullptr;
    ssize_t PlanLength = 0;
    const char* Statistics = nullptr;
    ssize_t StatisticsLength = 0;
    const char* Progress = nullptr;
    ssize_t ProgressLength = 0;
    const char* TaskInfo = nullptr;
    ssize_t TaskInfoLength = 0;

    const char* YsonError = nullptr;
    ssize_t YsonErrorLength = 0;
};

enum EQueryFileContentType
{
    RawInlineData,
    Url,
};

struct TBridgeQueryFile
{
    const char* Name = nullptr;
    size_t NameLength = 0;

    const char* Content = nullptr;
    size_t ContentLength = 0;

    EQueryFileContentType Type;
};

using TFuncBridgeFreeQueryResult = void(TBridgeQueryResult* result);
using TFuncBridgeRun = TBridgeQueryResult*(TBridgeYqlPlugin* plugin, const char* queryId, const char* impersonationUser, const char* queryText, const char* settings, const TBridgeQueryFile* files, int fileCount);
using TFuncBridgeGetProgress = TBridgeQueryResult*(TBridgeYqlPlugin* plugin, const char* queryId);
using TFuncBridgeAbort = void(TBridgeYqlPlugin* plugin, const char* queryId);

////////////////////////////////////////////////////////////////////////////////

#define FOR_EACH_BRIDGE_INTERFACE_FUNCTION(XX) \
    XX(BridgeCreateYqlPlugin) \
    XX(BridgeFreeYqlPlugin) \
    XX(BridgeFreeQueryResult) \
    XX(BridgeRun) \
    XX(BridgeGetProgress) \
    XX(BridgeGetAbiVersion)

////////////////////////////////////////////////////////////////////////////////