RelationalDBInterface_global.h

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2020 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_CORE_RELATIONALDBINTERFACE_GLOBAL_H_INCLUDED
#define RIPPLE_CORE_RELATIONALDBINTERFACE_GLOBAL_H_INCLUDED
 
#include <ripple/app/ledger/Ledger.h>
#include <ripple/app/misc/Manifest.h>
#include <ripple/core/Config.h>
#include <ripple/core/DatabaseCon.h>
#include <ripple/overlay/PeerReservationTable.h>
#include <ripple/peerfinder/impl/Store.h>
#include <boost/filesystem.hpp>
 
namespace ripple {
 
/* Wallet DB */
 
std::unique_ptr<DatabaseCon>
makeWalletDB(DatabaseCon::Setup const& setup);
 
std::unique_ptr<DatabaseCon>
makeTestWalletDB(DatabaseCon::Setup const& setup, std::string const& dbname);
 
void
getManifests(
    soci::session& session,
    std::string const& dbTable,
    ManifestCache& mCache,
    beast::Journal j);
 
void
saveManifests(
    soci::session& session,
    std::string const& dbTable,
    std::function<bool(PublicKey const&)> const& isTrusted,
    hash_map<PublicKey, Manifest> const& map,
    beast::Journal j);
 
void
addValidatorManifest(soci::session& session, std::string const& serialized);
 
std::pair<PublicKey, SecretKey>
getNodeIdentity(soci::session& session);
 
std::unordered_set<PeerReservation, beast::uhash<>, KeyEqual>
getPeerReservationTable(soci::session& session, beast::Journal j);
 
void
insertPeerReservation(
    soci::session& session,
    PublicKey const& nodeId,
    std::string const& description);
 
void
deletePeerReservation(soci::session& session, PublicKey const& nodeId);
 
bool
createFeatureVotes(soci::session& session);
 
// For historical reasons the up-vote and down-vote integer representations
// are unintuitive.
enum class AmendmentVote : int { up = 0, down = 1 };
 
void
readAmendments(
    soci::session& session,
    std::function<void(
        boost::optional<std::string> amendment_hash,
        boost::optional<std::string> amendment_name,
        boost::optional<AmendmentVote> vote)> const& callback);
 
void
voteAmendment(
    soci::session& session,
    uint256 const& amendment,
    std::string const& name,
    AmendmentVote vote);
 
/* State DB */
 
struct SavedState
{
    std::string writableDb;
    std::string archiveDb;
    LedgerIndex lastRotated;
};
 
void
initStateDB(
    soci::session& session,
    BasicConfig const& config,
    std::string const& dbName);
 
LedgerIndex
getCanDelete(soci::session& session);
 
LedgerIndex
setCanDelete(soci::session& session, LedgerIndex canDelete);
 
SavedState
getSavedState(soci::session& session);
 
void
setSavedState(soci::session& session, SavedState const& state);
 
void
setLastRotated(soci::session& session, LedgerIndex seq);
 
/* DatabaseBody DB */
 
std::pair<std::unique_ptr<DatabaseCon>, std::optional<std::uint64_t>>
openDatabaseBodyDb(
    DatabaseCon::Setup const& setup,
    boost::filesystem::path const& path);
 
std::uint64_t
databaseBodyDoPut(
    soci::session& session,
    std::string const& data,
    std::string const& path,
    std::uint64_t fileSize,
    std::uint64_t part,
    std::uint16_t maxRowSizePad);
 
void
databaseBodyFinish(soci::session& session, std::ofstream& fout);
 
/* Vacuum DB */
 
bool
doVacuumDB(DatabaseCon::Setup const& setup);
 
/* PeerFinder DB */
 
void
initPeerFinderDB(
    soci::session& session,
    BasicConfig const& config,
    beast::Journal j);
 
void
updatePeerFinderDB(
    soci::session& session,
    int currentSchemaVersion,
    beast::Journal j);
 
void
readPeerFinderDB(
    soci::session& session,
    std::function<void(std::string const&, int)> const& func);
 
void
savePeerFinderDB(
    soci::session& session,
    std::vector<PeerFinder::Store::Entry> const& v);
 
}  // namespace ripple
 
#endif