Синхронный QueryClient с более удобным API

[Gazizonoki]

Старый дизайн TQueryClient

class TQueryClient {
public:
    TQueryClient(const TDriver& driver, const TClientSettings& settings = TClientSettings());

    TAsyncExecuteQueryResult ExecuteQuery(const std::string& query, const TTxControl& txControl,
        const TExecuteQuerySettings& settings = TExecuteQuerySettings());

    TAsyncExecuteQueryResult ExecuteQuery(const std::string& query, const TTxControl& txControl,
        const TParams& params, const TExecuteQuerySettings& settings = TExecuteQuerySettings());

    TAsyncExecuteQueryIterator StreamExecuteQuery(const std::string& query, const TTxControl& txControl,
        const TExecuteQuerySettings& settings = TExecuteQuerySettings());

    TAsyncExecuteQueryIterator StreamExecuteQuery(const std::string& query, const TTxControl& txControl,
        const TParams& params, const TExecuteQuerySettings& settings = TExecuteQuerySettings());

    TAsyncExecuteQueryResult RetryQuery(TQueryResultFunc&& queryFunc, TRetryOperationSettings settings = TRetryOperationSettings());

    TAsyncStatus RetryQuery(TQueryFunc&& queryFunc, TRetryOperationSettings settings = TRetryOperationSettings());

    TAsyncStatus RetryQuery(TQueryWithoutSessionFunc&& queryFunc, TRetryOperationSettings settings = TRetryOperationSettings());

    TStatus RetryQuerySync(const TQuerySyncFunc& queryFunc, TRetryOperationSettings settings = TRetryOperationSettings());

    TStatus RetryQuerySync(const TQueryWithoutSessionSyncFunc& queryFunc, TRetryOperationSettings settings = TRetryOperationSettings());

    TAsyncExecuteQueryResult RetryQuery(const std::string& query, const TTxControl& txControl,
        TDuration timeout, bool isIndempotent);

    NThreading::TFuture<TScriptExecutionOperation> ExecuteScript(const std::string& script,
        const TExecuteScriptSettings& settings = TExecuteScriptSettings());

    NThreading::TFuture<TScriptExecutionOperation> ExecuteScript(const std::string& script,
        const TParams& params, const TExecuteScriptSettings& settings = TExecuteScriptSettings());

    TAsyncFetchScriptResultsResult FetchScriptResults(const NKikimr::NOperationId::TOperationId& operationId, int64_t resultSetIndex,
        const TFetchScriptResultsSettings& settings = TFetchScriptResultsSettings());

    TAsyncCreateSessionResult GetSession(const TCreateSessionSettings& settings = TCreateSessionSettings());

    //! Returns number of active sessions given via session pool
    int64_t GetActiveSessionCount() const;

    //! Returns the maximum number of sessions in session pool
    int64_t GetActiveSessionsLimit() const;

    //! Returns the size of session pool
    int64_t GetCurrentPoolSize() const;
};

class TSession {
public:
    const std::string& GetId() const;

    TAsyncExecuteQueryResult ExecuteQuery(const std::string& query, const TTxControl& txControl,
        const TExecuteQuerySettings& settings = TExecuteQuerySettings());

    TAsyncExecuteQueryResult ExecuteQuery(const std::string& query, const TTxControl& txControl,
        const TParams& params, const TExecuteQuerySettings& settings = TExecuteQuerySettings());

    TAsyncExecuteQueryIterator StreamExecuteQuery(const std::string& query, const TTxControl& txControl,
        const TExecuteQuerySettings& settings = TExecuteQuerySettings());

    TAsyncExecuteQueryIterator StreamExecuteQuery(const std::string& query, const TTxControl& txControl,
        const TParams& params, const TExecuteQuerySettings& settings = TExecuteQuerySettings());

    TAsyncBeginTransactionResult BeginTransaction(const TTxSettings& txSettings,
        const TBeginTxSettings& settings = TBeginTxSettings());
};

class TTransaction {
public:
    const std::string& GetId() const;

    bool IsActive() const;

    TAsyncCommitTransactionResult Commit(const TCommitTxSettings& settings = TCommitTxSettings());
    TAsyncStatus Rollback(const TRollbackTxSettings& settings = TRollbackTxSettings());

    TSession GetSession() const;
};

Это низкоуровневый интерфейс, который дает пользователю сессию для ручного использования, TTxControl для прямого использования, обработку ошибок через TStatus, который провоцирует boilerplate у пользователя, и асинхронное API, из-за которого при синхронном использовании получается колбаса из вызовов функций.

Такой интерфейс имеет место быть в очень высоконагруженных приложениях, но большинству пользователей он создает только лишние сложности. Предлагается сделать синхронный QueryClient, более дружелюбный к пользователю для решения большинства задач пользователя: NYdb::NQuerySync::TQueryClient.

Новый дизайн TQueryClient

namespace NYdb::NQuerySync {

struct TQueryResult;
struct TStreamQueryResult;

class TTransaction {
public:
    TQueryResult ExecuteQuery(const std::string& query, const TQuerySettings& settings = {});
    TStreamQueryResult ExecuteStreamQuery(const std::string& query, const TQuerySettings& settings = {});

    void Commit(const TCommitTxSettings& settings = {});
    void Rollback(const TRollbackTxSettings& settings = {});

    ~TTransaction(); // Commit
};

class TRetryHandle {
public:
    TTransaction BeginTx(const TBeginTxSettings& settings = {});

    TQueryResult ExecuteQuery(const std::string& query,
                              const TParams& params = {},
                              const TTxSettings& settings = {},
                              const TQuerySettings& settings = {});

    TStreamQueryResult ExecuteStreamQuery(const std::string& query,
                                          const TParams& params = {},
                                          const TTxSettings& settings = {},
                                          const TQuerySettings& settings = {});
};

class TQueryClient {
public:
    TQueryClient(const TDriver& driver, const TClientSettings& settings = TClientSettings());

    void Retry(std::function<void(TRetryHandle handle)>, const NRetry::TRetryOperationSettings& settings = {});
    void RetryTx(std::function<void(TTransaction& tx)>, const NRetry::TRetryOperationSettings& settings = {});

    TTransaction BeginTx(const TTxSettings& settings = {});

    TQueryResult ExecuteQuery(const std::string& query,
                              const TParams& params = {},
                              const TTxSettings& settings = {},
                              const TQuerySettings& settings = {});

    TStreamQueryResult ExecuteStreamQuery(const std::string& query,
                                          const TParams& params = {},
                                          const TTxSettings& settings = {},
                                          const TQuerySettings& settings = {});

    void Stop();
};

}

1. На серверные ошибки кидается исключение TDbRequestError.
2. Lazy создание клиента из драйвера напрямую.
3. Не даем пользователю сессии напрямую.
4. TRetryHandle - не владеет сессией, а дает API к ней
5. Вместо TTxControl транзакция создается с объектом TTransaction и действует на протяжении его лайфтайма. (Как в libpqxx)

Один запрос в транзакции (на явной сессии)

Было:

NYdb::TDriver driver{"grpc://localhost:2136/?database=local"};
NYdb::NQuery::TQueryClient client{driver};
auto getSessRes = client.GetSession().GetValueSync();
if (!getSessRes.IsSuccess()) {
    std::cerr << ToString(getSessRes);
}
auto session = getSessRes.GetSession();
auto result = session.ExecuteQuery("SELECT 1;", NYdb::NQuery::TTxControl::BeginTx().CommitTx()).GetValueSync();
if (!result.IsSuccess()) {
    std::cerr << ToString(result);
}
// parse result

Стало:

NYdb::TDriver driver{"grpc://localhost:2136/local"};
try {
    auto result = driver.Query().ExecuteQuery("SELECT 1;");
    // parse result
} catch (NYdb::TDbRequestError& e) {
    std::cerr << e;
}

Ретрай запроса

Было:

NYdb::TDriver driver{"grpc://localhost:2136/?database=local"};
NYdb::NQuery::TQueryClient client{driver};
auto result = client.RetryQuery([](TSession session) {
    return session.ExecuteQuery("SELECT 1;", NYdb::NQuery::TTxControl::BeginTx().CommitTx());
}).GetValueSync();
if (!result.IsSuccess()) {
    std::cerr << ToString(getSessRes);
}
// parse result

Стало:

NYdb::TDriver driver{"grpc://localhost:2136/local"};
try {
    driver.Query().Retry([](TRetryHandle handle) {
        auto result = handle.ExecuteQuery("SELECT 1;");
        // parse result
    });
} catch (NYdb::TDbRequestError& e) {
    std::cerr << e;
}

Интерактивная транзакция

Было:

NYdb::TDriver driver{"grpc://localhost:2136/?database=local"};
NYdb::NQuery::TQueryClient client{driver};
auto getSessRes = client.GetSession().GetValueSync();
if (!getSessRes.IsSuccess()) {
    std::cerr << ToString(getSessRes);
}
auto session = getSessRes.GetSession();
auto result1 = session.ExecuteQuery("SELECT 1;", NYdb::NQuery::TTxControl::BeginTx().CommitTx()).GetValueSync();
if (!result1.IsSuccess()) {
    std::cerr << ToString(result1);
}
// parse result
auto result2 = session.ExecuteQuery("SELECT 2;", NYdb::NQuery::TTxControl::Tx(result.GetTransaction().GetId()).CommitTx()).GetValueSync();
if (!result2.IsSuccess()) {
    std::cerr << ToString(result2);
}
// parse result

Стало:

NYdb::TDriver driver{"grpc://localhost:2136/local"};
try {
    auto tx = driver.Query().BeginTx();
    auto result1 = tx.ExecuteQuery("SELECT 1;");
    // parse result
    auto result2 = tx.ExecuteQuery("SELECT 2;");
    // parse result
} catch (NYdb::TDbRequestError& e) {
    std::cerr << e;
}

Ретрай интерактивной транзакции

Было:

NYdb::TDriver driver{"grpc://localhost:2136/?database=local"};
NYdb::NQuery::TQueryClient client{driver};
auto status = client.RetryQuery([](TSession session) {
    auto result1 = session.ExecuteQuery("SELECT 1;", NYdb::NQuery::TTxControl::BeginTx().CommitTx()).GetValueSync();
    if (!result1.IsSuccess()) {
        std::cerr << ToString(result1);
        return result1;
    }
    // parse result
    auto result2 = session.ExecuteQuery("SELECT 2;", 
    NYdb::NQuery::TTxControl::Tx(result.GetTransaction().GetId()).CommitTx()).GetValueSync();
    if (!result2.IsSuccess()) {
        std::cerr << ToString(result2);
        return result2;
    }
    // parse result
}).GetValueSync();
if (!status.IsSuccess()) {
    std::cerr << ToString(getSessRes);
}

Стало:

NYdb::TDriver driver{"grpc://localhost:2136/local"};
try {
    client.Query().RetryTx([](TTransaction& tx) {
        auto result1 = tx.ExecuteQuery("SELECT 1;");
        // parse result
        auto result2 = tx.ExecuteQuery("SELECT 2;");
        // parse result
    });
} catch (NYdb::TDbRequestError& e) {
    std::cerr << e;
}