SQLiteDatabase.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_APP_RDB_BACKEND_SQLITEDATABASE_H_INCLUDED
#define RIPPLE_APP_RDB_BACKEND_SQLITEDATABASE_H_INCLUDED
 
#include <ripple/app/rdb/RelationalDatabase.h>
 
namespace ripple {
 
class SQLiteDatabase : public RelationalDatabase
{
public:
    virtual std::optional<LedgerIndex>
    getTransactionsMinLedgerSeq() = 0;
 
    virtual std::optional<LedgerIndex>
    getAccountTransactionsMinLedgerSeq() = 0;
 
    virtual void
    deleteTransactionByLedgerSeq(LedgerIndex ledgerSeq) = 0;
 
    virtual void
    deleteBeforeLedgerSeq(LedgerIndex ledgerSeq) = 0;
 
    virtual void
    deleteTransactionsBeforeLedgerSeq(LedgerIndex ledgerSeq) = 0;
 
    virtual void
    deleteAccountTransactionsBeforeLedgerSeq(LedgerIndex ledgerSeq) = 0;
 
    virtual std::size_t
    getTransactionCount() = 0;
 
    virtual std::size_t
    getAccountTransactionCount() = 0;
 
    virtual struct CountMinMax
    getLedgerCountMinMax() = 0;
 
    virtual bool
    saveValidatedLedger(
        std::shared_ptr<Ledger const> const& ledger,
        bool current) = 0;
 
    virtual std::optional<LedgerInfo>
    getLimitedOldestLedgerInfo(LedgerIndex ledgerFirstIndex) = 0;
 
    virtual std::optional<LedgerInfo>
    getLimitedNewestLedgerInfo(LedgerIndex ledgerFirstIndex) = 0;
 
    virtual AccountTxs
    getOldestAccountTxs(AccountTxOptions const& options) = 0;
 
    virtual AccountTxs
    getNewestAccountTxs(AccountTxOptions const& options) = 0;
 
    virtual MetaTxsList
    getOldestAccountTxsB(AccountTxOptions const& options) = 0;
 
    virtual MetaTxsList
    getNewestAccountTxsB(AccountTxOptions const& options) = 0;
 
    virtual std::pair<AccountTxs, std::optional<AccountTxMarker>>
    oldestAccountTxPage(AccountTxPageOptions const& options) = 0;
 
    virtual std::pair<AccountTxs, std::optional<AccountTxMarker>>
    newestAccountTxPage(AccountTxPageOptions const& options) = 0;
 
    virtual std::pair<MetaTxsList, std::optional<AccountTxMarker>>
    oldestAccountTxPageB(AccountTxPageOptions const& options) = 0;
 
    virtual std::pair<MetaTxsList, std::optional<AccountTxMarker>>
    newestAccountTxPageB(AccountTxPageOptions const& options) = 0;
 
    virtual std::variant<AccountTx, TxSearched>
    getTransaction(
        uint256 const& id,
        std::optional<ClosedInterval<uint32_t>> const& range,
        error_code_i& ec) = 0;
 
    virtual uint32_t
    getKBUsedAll() = 0;
 
    virtual uint32_t
    getKBUsedLedger() = 0;
 
    virtual uint32_t
    getKBUsedTransaction() = 0;
 
    virtual void
    closeLedgerDB() = 0;
 
    virtual void
    closeTransactionDB() = 0;
};
 
}  // namespace ripple
 
#endif