DatabaseShard.h

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2012, 2017 Ripple Labs Inc.
 
    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#ifndef RIPPLE_NODESTORE_DATABASESHARD_H_INCLUDED
#define RIPPLE_NODESTORE_DATABASESHARD_H_INCLUDED
 
#include <ripple/app/ledger/Ledger.h>
#include <ripple/core/SociDB.h>
#include <ripple/nodestore/Database.h>
#include <ripple/nodestore/ShardInfo.h>
#include <ripple/nodestore/Types.h>
 
#include <memory>
#include <optional>
 
namespace ripple {
namespace NodeStore {
 
class DatabaseShard : public Database
{
public:
    DatabaseShard(
        Scheduler& scheduler,
        int readThreads,
        Section const& config,
        beast::Journal journal)
        : Database(scheduler, readThreads, config, journal)
    {
    }
 
    [[nodiscard]] virtual bool
    init() = 0;
 
    [[nodiscard]] virtual std::optional<std::uint32_t>
    prepareLedger(std::uint32_t validLedgerSeq) = 0;
 
    [[nodiscard]] virtual bool
    prepareShards(std::vector<std::uint32_t> const& shardIndexes) = 0;
 
    virtual void
    removePreShard(std::uint32_t shardIndex) = 0;
 
    [[nodiscard]] virtual std::string
    getPreShards() = 0;
 
    [[nodiscard]] virtual bool
    importShard(
        std::uint32_t shardIndex,
        boost::filesystem::path const& srcDir) = 0;
 
    [[nodiscard]] virtual std::shared_ptr<Ledger>
    fetchLedger(uint256 const& hash, std::uint32_t seq) = 0;
 
    virtual void
    setStored(std::shared_ptr<Ledger const> const& ledger) = 0;
 
    virtual bool
    callForLedgerSQLByLedgerSeq(
        LedgerIndex ledgerSeq,
        std::function<bool(soci::session& session)> const& callback) = 0;
 
    virtual bool
    callForLedgerSQLByShardIndex(
        std::uint32_t shardIndex,
        std::function<bool(soci::session& session)> const& callback) = 0;
 
    virtual bool
    callForTransactionSQLByLedgerSeq(
        LedgerIndex ledgerSeq,
        std::function<bool(soci::session& session)> const& callback) = 0;
 
    virtual bool
    callForTransactionSQLByShardIndex(
        std::uint32_t shardIndex,
        std::function<bool(soci::session& session)> const& callback) = 0;
 
    virtual bool
    iterateLedgerSQLsForward(
        std::optional<std::uint32_t> minShardIndex,
        std::function<
            bool(soci::session& session, std::uint32_t shardIndex)> const&
            callback) = 0;
 
    virtual bool
    iterateTransactionSQLsForward(
        std::optional<std::uint32_t> minShardIndex,
        std::function<
            bool(soci::session& session, std::uint32_t shardIndex)> const&
            callback) = 0;
 
    virtual bool
    iterateLedgerSQLsBack(
        std::optional<std::uint32_t> maxShardIndex,
        std::function<
            bool(soci::session& session, std::uint32_t shardIndex)> const&
            callback) = 0;
 
    virtual bool
    iterateTransactionSQLsBack(
        std::optional<std::uint32_t> maxShardIndex,
        std::function<
            bool(soci::session& session, std::uint32_t shardIndex)> const&
            callback) = 0;
 
    [[nodiscard]] virtual std::unique_ptr<ShardInfo>
    getShardInfo() const = 0;
 
    [[nodiscard]] virtual boost::filesystem::path const&
    getRootDir() const = 0;
 
    virtual Json::Value
    getDatabaseImportStatus() const = 0;
 
    virtual Json::Value
    startNodeToShard() = 0;
 
    virtual Json::Value
    stopNodeToShard() = 0;
 
    virtual std::optional<std::uint32_t>
    getDatabaseImportSequence() const = 0;
 
    [[nodiscard]] virtual size_t
    getNumTasks() const = 0;
};
 
extern std::unique_ptr<DatabaseShard>
make_ShardStore(
    Application& app,
    Scheduler& scheduler,
    int readThreads,
    beast::Journal j);
 
}  // namespace NodeStore
}  // namespace ripple
 
#endif