#include <RelationalDatabase.h>

Inheritance diagram for ripple::RelationalDatabase:

[legend]

Classes
struct	AccountTxArgs

struct	AccountTxMarker

struct	AccountTxOptions

struct	AccountTxPageOptions

struct	AccountTxResult

struct	CountMinMax

Public Types
using	AccountTx = std::pair< std::shared_ptr< Transaction >, std::shared_ptr< TxMeta > >

using	AccountTxs = std::vector< AccountTx >

using	txnMetaLedgerType = std::tuple< Blob, Blob, std::uint32_t >

using	MetaTxsList = std::vector< txnMetaLedgerType >

using	LedgerSequence = uint32_t

using	LedgerHash = uint256

using	LedgerShortcut = RPC::LedgerShortcut

using	LedgerSpecifier = std::variant< LedgerRange, LedgerShortcut, LedgerSequence, LedgerHash >

Public Member Functions
virtual	~RelationalDatabase ()=default

virtual std::optional< LedgerIndex >	getMinLedgerSeq ()=0
	getMinLedgerSeq Returns the minimum ledger sequence in the Ledgers table.

virtual std::optional< LedgerIndex >	getMaxLedgerSeq ()=0
	getMaxLedgerSeq Returns the maximum ledger sequence in the Ledgers table.

virtual std::optional< LedgerInfo >	getLedgerInfoByIndex (LedgerIndex ledgerSeq)=0
	getLedgerInfoByIndex Returns a ledger by its sequence.

virtual std::optional< LedgerInfo >	getNewestLedgerInfo ()=0
	getNewestLedgerInfo Returns the info of the newest saved ledger.

virtual std::optional< LedgerInfo >	getLedgerInfoByHash (uint256 const &ledgerHash)=0
	getLedgerInfoByHash Returns the info of the ledger with given hash.

virtual uint256	getHashByIndex (LedgerIndex ledgerIndex)=0
	getHashByIndex Returns the hash of the ledger with the given sequence.

virtual std::optional< LedgerHashPair >	getHashesByIndex (LedgerIndex ledgerIndex)=0
	getHashesByIndex Returns the hashes of the ledger and its parent as specified by the ledgerIndex.

virtual std::map< LedgerIndex, LedgerHashPair >	getHashesByIndex (LedgerIndex minSeq, LedgerIndex maxSeq)=0
	getHashesByIndex Returns hashes of each ledger and its parent for all ledgers within the provided range.

virtual std::vector< std::shared_ptr< Transaction > >	getTxHistory (LedgerIndex startIndex)=0
	getTxHistory Returns the 20 most recent transactions starting from the given number.

virtual bool	ledgerDbHasSpace (Config const &config)=0
	ledgerDbHasSpace Checks if the ledger database has available space.

virtual bool	transactionDbHasSpace (Config const &config)=0
	transactionDbHasSpace Checks if the transaction database has available space.

Static Public Member Functions
static std::unique_ptr< RelationalDatabase >	init (Application &app, Config const &config, JobQueue &jobQueue)
	init Creates and returns an appropriate RelationalDatabase instance based on configuration.

Detailed Description

Definition at line 30 of file RelationalDatabase.h.

Member Typedef Documentation

◆ AccountTx

using ripple::RelationalDatabase::AccountTx = std::pair<std::shared_ptr<Transaction>, std::shared_ptr<TxMeta> >

Definition at line 66 of file RelationalDatabase.h.

◆ AccountTxs

using ripple::RelationalDatabase::AccountTxs = std::vector<AccountTx>

Definition at line 68 of file RelationalDatabase.h.

◆ txnMetaLedgerType

using ripple::RelationalDatabase::txnMetaLedgerType = std::tuple<Blob, Blob, std::uint32_t>

Definition at line 69 of file RelationalDatabase.h.

◆ MetaTxsList

using ripple::RelationalDatabase::MetaTxsList = std::vector<txnMetaLedgerType>

Definition at line 70 of file RelationalDatabase.h.

◆ LedgerSequence

using ripple::RelationalDatabase::LedgerSequence = uint32_t

Definition at line 72 of file RelationalDatabase.h.

◆ LedgerHash

using ripple::RelationalDatabase::LedgerHash = uint256

Definition at line 73 of file RelationalDatabase.h.

◆ LedgerShortcut

using ripple::RelationalDatabase::LedgerShortcut = RPC::LedgerShortcut

Definition at line 74 of file RelationalDatabase.h.

◆ LedgerSpecifier

using ripple::RelationalDatabase::LedgerSpecifier = std::variant<LedgerRange, LedgerShortcut, LedgerSequence, LedgerHash>

Definition at line 75 of file RelationalDatabase.h.

Constructor & Destructor Documentation

◆ ~RelationalDatabase()

virtual ripple::RelationalDatabase::~RelationalDatabase ( )

virtualdefault

Member Function Documentation

◆ init()

std::unique_ptr< RelationalDatabase > ripple::RelationalDatabase::init	(	Application &	app,
		Config const &	config,
		JobQueue &	jobQueue
	)

static

init Creates and returns an appropriate RelationalDatabase instance based on configuration.

Parameters

app	Application object.
config	Config object.
jobQueue	JobQueue object.

Returns: Unique pointer to the interface.

Definition at line 11 of file RelationalDatabase.cpp.

◆ getMinLedgerSeq()

virtual std::optional< LedgerIndex > ripple::RelationalDatabase::getMinLedgerSeq ( )

pure virtual

getMinLedgerSeq Returns the minimum ledger sequence in the Ledgers table.

Returns: Ledger sequence or no value if no ledgers exist.

Implemented in ripple::SQLiteDatabaseImp.

◆ getMaxLedgerSeq()

virtual std::optional< LedgerIndex > ripple::RelationalDatabase::getMaxLedgerSeq ( )

pure virtual

getMaxLedgerSeq Returns the maximum ledger sequence in the Ledgers table.

Returns: Ledger sequence or none if no ledgers exist.

Implemented in ripple::SQLiteDatabaseImp.

◆ getLedgerInfoByIndex()

virtual std::optional< LedgerInfo > ripple::RelationalDatabase::getLedgerInfoByIndex ( LedgerIndex ledgerSeq )

pure virtual

getLedgerInfoByIndex Returns a ledger by its sequence.

Parameters

ledgerSeq Ledger sequence.

Returns: The ledger if found, otherwise no value.

Implemented in ripple::SQLiteDatabaseImp.

◆ getNewestLedgerInfo()

virtual std::optional< LedgerInfo > ripple::RelationalDatabase::getNewestLedgerInfo ( )

pure virtual

getNewestLedgerInfo Returns the info of the newest saved ledger.

Returns: Ledger info if found, otherwise no value.

Implemented in ripple::SQLiteDatabaseImp.

◆ getLedgerInfoByHash()

virtual std::optional< LedgerInfo > ripple::RelationalDatabase::getLedgerInfoByHash ( uint256 const & ledgerHash )

pure virtual

getLedgerInfoByHash Returns the info of the ledger with given hash.

Parameters

ledgerHash Hash of the ledger.

Returns: Ledger if found, otherwise no value.

Implemented in ripple::SQLiteDatabaseImp.

◆ getHashByIndex()

virtual uint256 ripple::RelationalDatabase::getHashByIndex ( LedgerIndex ledgerIndex )

pure virtual

getHashByIndex Returns the hash of the ledger with the given sequence.

Parameters

ledgerIndex Ledger sequence.

Returns: Hash of the ledger.

Implemented in ripple::SQLiteDatabaseImp.

◆ getHashesByIndex() [1/2]

virtual std::optional< LedgerHashPair > ripple::RelationalDatabase::getHashesByIndex ( LedgerIndex ledgerIndex )

pure virtual

getHashesByIndex Returns the hashes of the ledger and its parent as specified by the ledgerIndex.

Parameters

ledgerIndex Ledger sequence.

Returns: Struct LedgerHashPair which contains hashes of the ledger and its parent.

Implemented in ripple::SQLiteDatabaseImp.

◆ getHashesByIndex() [2/2]

virtual std::map< LedgerIndex, LedgerHashPair > ripple::RelationalDatabase::getHashesByIndex	(	LedgerIndex	minSeq,
		LedgerIndex	maxSeq
	)

pure virtual

getHashesByIndex Returns hashes of each ledger and its parent for all ledgers within the provided range.

Parameters

minSeq	Minimum ledger sequence.
maxSeq	Maximum ledger sequence.

Returns: Container that maps the sequence number of a found ledger to the struct LedgerHashPair which contains the hashes of the ledger and its parent.

Implemented in ripple::SQLiteDatabaseImp.

◆ getTxHistory()

virtual std::vector< std::shared_ptr< Transaction > > ripple::RelationalDatabase::getTxHistory ( LedgerIndex startIndex )

pure virtual

getTxHistory Returns the 20 most recent transactions starting from the given number.

Parameters

startIndex First number of returned entry.

Returns: Vector of shared pointers to transactions sorted in descending order by ledger sequence.

Implemented in ripple::SQLiteDatabaseImp.

◆ ledgerDbHasSpace()

virtual bool ripple::RelationalDatabase::ledgerDbHasSpace ( Config const & config )

pure virtual

ledgerDbHasSpace Checks if the ledger database has available space.

Parameters

config Config object.

Returns: True if space is available.

Implemented in ripple::SQLiteDatabaseImp.

◆ transactionDbHasSpace()

virtual bool ripple::RelationalDatabase::transactionDbHasSpace ( Config const & config )

pure virtual

transactionDbHasSpace Checks if the transaction database has available space.

Parameters

config Config object.

Returns: True if space is available.

Implemented in ripple::SQLiteDatabaseImp.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ AccountTx

◆ AccountTxs

◆ txnMetaLedgerType

◆ MetaTxsList

◆ LedgerSequence

◆ LedgerHash

◆ LedgerShortcut

◆ LedgerSpecifier

Constructor & Destructor Documentation

◆ ~RelationalDatabase()

Member Function Documentation

◆ init()

◆ getMinLedgerSeq()

◆ getMaxLedgerSeq()

◆ getLedgerInfoByIndex()

◆ getNewestLedgerInfo()

◆ getLedgerInfoByHash()

◆ getHashByIndex()

◆ getHashesByIndex() [1/2]

◆ getHashesByIndex() [2/2]

◆ getTxHistory()

◆ ledgerDbHasSpace()

◆ transactionDbHasSpace()