The interface to the database used by Clio. More...

#include <BackendInterface.hpp>

Inheritance diagram for data::BackendInterface:

[legend]

Collaboration diagram for data::BackendInterface:

Public Types
using	ClioNodesDataFetchResult
	Return type for fetchClioNodesData() method.

Public Member Functions
	BackendInterface (LedgerCacheInterface &cache)
	Construct a new backend interface instance.
LedgerCacheInterface const &	cache () const
LedgerCacheInterface &	cache ()
void	setCorruptionDetector (etl::CorruptionDetector detector)
	Sets the corruption detector.
virtual std::optional< ripple::LedgerHeader >	fetchLedgerBySequence (std::uint32_t sequence, boost::asio::yield_context yield) const =0
	Fetches a specific ledger by sequence number.
virtual std::optional< ripple::LedgerHeader >	fetchLedgerByHash (ripple::uint256 const &hash, boost::asio::yield_context yield) const =0
	Fetches a specific ledger by hash.
virtual std::optional< std::uint32_t >	fetchLatestLedgerSequence (boost::asio::yield_context yield) const =0
	Fetches the latest ledger sequence.
std::optional< LedgerRange >	fetchLedgerRange () const
	Fetch the current ledger range.
virtual std::vector< ripple::uint256 >	fetchAccountRoots (std::uint32_t number, std::uint32_t pageSize, std::uint32_t seq, boost::asio::yield_context yield) const =0
	Fetch the specified number of account root object indexes by page, the accounts need to exist for seq.
void	updateRange (uint32_t newMax)
	Updates the range of sequences that are stored in the DB.
void	setRange (uint32_t min, uint32_t max, bool force=false)
	Sets the range of sequences that are stored in the DB.
std::optional< ripple::Fees >	fetchFees (std::uint32_t seq, boost::asio::yield_context yield) const
	Fetch the fees from a specific ledger sequence.
virtual std::optional< TransactionAndMetadata >	fetchTransaction (ripple::uint256 const &hash, boost::asio::yield_context yield) const =0
	Fetches a specific transaction.
virtual std::vector< TransactionAndMetadata >	fetchTransactions (std::vector< ripple::uint256 > const &hashes, boost::asio::yield_context yield) const =0
	Fetches multiple transactions.
virtual TransactionsAndCursor	fetchAccountTransactions (ripple::AccountID const &account, std::uint32_t limit, bool forward, std::optional< TransactionsCursor > const &txnCursor, boost::asio::yield_context yield) const =0
	Fetches all transactions for a specific account.
virtual std::vector< TransactionAndMetadata >	fetchAllTransactionsInLedger (std::uint32_t ledgerSequence, boost::asio::yield_context yield) const =0
	Fetches all transactions from a specific ledger.
virtual std::vector< ripple::uint256 >	fetchAllTransactionHashesInLedger (std::uint32_t ledgerSequence, boost::asio::yield_context yield) const =0
	Fetches all transaction hashes from a specific ledger.
virtual std::optional< NFT >	fetchNFT (ripple::uint256 const &tokenID, std::uint32_t ledgerSequence, boost::asio::yield_context yield) const =0
	Fetches a specific NFT.
virtual TransactionsAndCursor	fetchNFTTransactions (ripple::uint256 const &tokenID, std::uint32_t limit, bool forward, std::optional< TransactionsCursor > const &cursorIn, boost::asio::yield_context yield) const =0
	Fetches all transactions for a specific NFT.
virtual NFTsAndCursor	fetchNFTsByIssuer (ripple::AccountID const &issuer, std::optional< std::uint32_t > const &taxon, std::uint32_t ledgerSequence, std::uint32_t limit, std::optional< ripple::uint256 > const &cursorIn, boost::asio::yield_context yield) const =0
	Fetches all NFTs issued by a given address.
virtual MPTHoldersAndCursor	fetchMPTHolders (ripple::uint192 const &mptID, std::uint32_t const limit, std::optional< ripple::AccountID > const &cursorIn, std::uint32_t const ledgerSequence, boost::asio::yield_context yield) const =0
	Fetches all holders' balances for a MPTIssuanceID.
std::optional< Blob >	fetchLedgerObject (ripple::uint256 const &key, std::uint32_t sequence, boost::asio::yield_context yield) const
	Fetches a specific ledger object.
std::optional< std::uint32_t >	fetchLedgerObjectSeq (ripple::uint256 const &key, std::uint32_t sequence, boost::asio::yield_context yield) const
	Fetches a specific ledger object sequence.
std::vector< Blob >	fetchLedgerObjects (std::vector< ripple::uint256 > const &keys, std::uint32_t sequence, boost::asio::yield_context yield) const
	Fetches all ledger objects by their keys.
virtual std::optional< Blob >	doFetchLedgerObject (ripple::uint256 const &key, std::uint32_t sequence, boost::asio::yield_context yield) const =0
	The database-specific implementation for fetching a ledger object.
virtual std::optional< std::uint32_t >	doFetchLedgerObjectSeq (ripple::uint256 const &key, std::uint32_t sequence, boost::asio::yield_context yield) const =0
	The database-specific implementation for fetching a ledger object sequence.
virtual std::vector< Blob >	doFetchLedgerObjects (std::vector< ripple::uint256 > const &keys, std::uint32_t sequence, boost::asio::yield_context yield) const =0
	The database-specific implementation for fetching ledger objects.
virtual std::vector< LedgerObject >	fetchLedgerDiff (std::uint32_t ledgerSequence, boost::asio::yield_context yield) const =0
	Returns the difference between ledgers.
LedgerPage	fetchLedgerPage (std::optional< ripple::uint256 > const &cursor, std::uint32_t ledgerSequence, std::uint32_t limit, bool outOfOrder, boost::asio::yield_context yield)
	Fetches a page of ledger objects, ordered by key/index.
std::optional< LedgerObject >	fetchSuccessorObject (ripple::uint256 key, std::uint32_t ledgerSequence, boost::asio::yield_context yield) const
	Fetches the successor object.
std::optional< ripple::uint256 >	fetchSuccessorKey (ripple::uint256 key, std::uint32_t ledgerSequence, boost::asio::yield_context yield) const
	Fetches the successor key.
virtual std::optional< ripple::uint256 >	doFetchSuccessorKey (ripple::uint256 key, std::uint32_t ledgerSequence, boost::asio::yield_context yield) const =0
	Database-specific implementation of fetching the successor key.
BookOffersPage	fetchBookOffers (ripple::uint256 const &book, std::uint32_t ledgerSequence, std::uint32_t limit, boost::asio::yield_context yield) const
	Fetches book offers.
virtual std::optional< std::string >	fetchMigratorStatus (std::string const &migratorName, boost::asio::yield_context yield) const =0
	Fetches the status of migrator by name.
virtual ClioNodesDataFetchResult	fetchClioNodesData (boost::asio::yield_context yield) const =0
	Fetches the data of all nodes in the cluster.
std::optional< LedgerRange >	hardFetchLedgerRange () const
	Synchronously fetches the ledger range from DB.
virtual std::optional< LedgerRange >	hardFetchLedgerRange (boost::asio::yield_context yield) const =0
	Fetches the ledger range from DB.
std::optional< LedgerRange >	hardFetchLedgerRangeNoThrow () const
	Fetches the ledger range from DB retrying until no DatabaseTimeout is thrown.
virtual void	writeLedger (ripple::LedgerHeader const &ledgerHeader, std::string &&blob)=0
	Writes to a specific ledger.
virtual void	writeLedgerObject (std::string &&key, std::uint32_t seq, std::string &&blob)
	Writes a new ledger object.
virtual void	writeTransaction (std::string &&hash, std::uint32_t seq, std::uint32_t date, std::string &&transaction, std::string &&metadata)=0
	Writes a new transaction.
virtual void	writeNFTs (std::vector< NFTsData > const &data)=0
	Writes NFTs to the database.
virtual void	writeAccountTransactions (std::vector< AccountTransactionsData > data)=0
	Write a new set of account transactions.
virtual void	writeAccountTransaction (AccountTransactionsData record)=0
	Write a new account transaction.
virtual void	writeNFTTransactions (std::vector< NFTTransactionsData > const &data)=0
	Write NFTs transactions.
virtual void	writeMPTHolders (std::vector< MPTHolderData > const &data)=0
	Write accounts that started holding onto a MPT.
virtual void	writeSuccessor (std::string &&key, std::uint32_t seq, std::string &&successor)=0
	Write a new successor.
virtual void	writeNodeMessage (boost::uuids::uuid const &uuid, std::string message)=0
	Write a node message. Used by ClusterCommunicationService.
virtual void	startWrites () const =0
	Starts a write transaction with the DB. No-op for cassandra.
bool	finishWrites (std::uint32_t ledgerSequence)
	Tells database we finished writing all data for a specific ledger.
virtual void	waitForWritesToFinish ()=0
	Wait for all pending writes to finish.
virtual void	writeMigratorStatus (std::string const &migratorName, std::string const &status)=0
	Mark the migration status of a migrator as Migrated in the database.
virtual bool	isTooBusy () const =0
virtual boost::json::object	stats () const =0

Protected Attributes
util::Logger	log_ {"Backend"}
std::shared_mutex	rngMtx_
std::optional< LedgerRange >	range_
std::reference_wrapper< LedgerCacheInterface >	cache_
std::optional< etl::CorruptionDetector >	corruptionDetector_

Detailed Description

The interface to the database used by Clio.

Member Typedef Documentation

◆ ClioNodesDataFetchResult

using data::BackendInterface::ClioNodesDataFetchResult

Initial value:

std::expected<std::vector<std::pair<boost::uuids::uuid, std::string>>, std::string>

Return type for fetchClioNodesData() method.

Constructor & Destructor Documentation

◆ BackendInterface()

data::BackendInterface::BackendInterface ( LedgerCacheInterface & cache )

inline

Construct a new backend interface instance.

Parameters

cache The ledger cache to use

Member Function Documentation

◆ cache() [1/2]

LedgerCacheInterface & data::BackendInterface::cache ( )

inline

Returns: Mutable cache

◆ cache() [2/2]

LedgerCacheInterface const & data::BackendInterface::cache ( ) const

inline

Returns: Immutable cache

◆ doFetchLedgerObject()

virtual std::optional< Blob > data::BackendInterface::doFetchLedgerObject	(	ripple::uint256 const &	key,
		std::uint32_t	sequence,
		boost::asio::yield_context	yield ) const

pure virtual

The database-specific implementation for fetching a ledger object.

Parameters

key	The key to fetch for
sequence	The ledger sequence to fetch for
yield	The coroutine context

Returns: The object as a Blob on success; nullopt otherwise

◆ doFetchLedgerObjects()

virtual std::vector< Blob > data::BackendInterface::doFetchLedgerObjects	(	std::vector< ripple::uint256 > const &	keys,
		std::uint32_t	sequence,
		boost::asio::yield_context	yield ) const

pure virtual

The database-specific implementation for fetching ledger objects.

Parameters

keys	The keys to fetch for
sequence	The ledger sequence to fetch for
yield	The coroutine context

Returns: A vector of Blobs representing each fetched object

◆ doFetchLedgerObjectSeq()

virtual std::optional< std::uint32_t > data::BackendInterface::doFetchLedgerObjectSeq	(	ripple::uint256 const &	key,
		std::uint32_t	sequence,
		boost::asio::yield_context	yield ) const

pure virtual

The database-specific implementation for fetching a ledger object sequence.

Parameters

key	The key to fetch for
sequence	The ledger sequence to fetch for
yield	The coroutine context

Returns: The sequence in unit32_t on success; nullopt otherwise

◆ doFetchSuccessorKey()

virtual std::optional< ripple::uint256 > data::BackendInterface::doFetchSuccessorKey	(	ripple::uint256	key,
		std::uint32_t	ledgerSequence,
		boost::asio::yield_context	yield ) const

pure virtual

Database-specific implementation of fetching the successor key.

Parameters

key	The key to fetch for
ledgerSequence	The ledger sequence to fetch for
yield	The coroutine context

Returns: The successor on success; nullopt otherwise

◆ fetchAccountRoots()

virtual std::vector< ripple::uint256 > data::BackendInterface::fetchAccountRoots	(	std::uint32_t	number,
		std::uint32_t	pageSize,
		std::uint32_t	seq,
		boost::asio::yield_context	yield ) const

pure virtual

Fetch the specified number of account root object indexes by page, the accounts need to exist for seq.

Parameters

number	The number of accounts to fetch
pageSize	The maximum number of accounts per page
seq	The accounts need to exist for this sequence
yield	The coroutine context

Returns: A vector of ripple::uint256 representing the account roots

Implemented in data::cassandra::BasicCassandraBackend< SettingsProviderType, ExecutionStrategyType, FetchLedgerCacheType >, data::cassandra::BasicCassandraBackend< SettingsProvider, impl::DefaultExecutionStrategy<> >, data::cassandra::BasicKeyspaceBackend< SettingsProviderType, ExecutionStrategyType, FetchLedgerCacheType >, and data::cassandra::BasicKeyspaceBackend< SettingsProvider, impl::DefaultExecutionStrategy<> >.

◆ fetchAccountTransactions()

virtual TransactionsAndCursor data::BackendInterface::fetchAccountTransactions	(	ripple::AccountID const &	account,
		std::uint32_t	limit,
		bool	forward,
		std::optional< TransactionsCursor > const &	txnCursor,
		boost::asio::yield_context	yield ) const

pure virtual

Fetches all transactions for a specific account.

Parameters

account	The account to fetch transactions for
limit	The maximum number of transactions per result page
forward	Whether to fetch the page forwards or backwards from the given cursor
txnCursor	The cursor to resume fetching from
yield	The coroutine context

Returns: Results and a cursor to resume from

◆ fetchAllTransactionHashesInLedger()

virtual std::vector< ripple::uint256 > data::BackendInterface::fetchAllTransactionHashesInLedger	(	std::uint32_t	ledgerSequence,
		boost::asio::yield_context	yield ) const

pure virtual

Fetches all transaction hashes from a specific ledger.

Parameters

ledgerSequence	The ledger sequence to fetch for
yield	The coroutine context

Returns: Hashes as ripple::uint256 in a vector

◆ fetchAllTransactionsInLedger()

virtual std::vector< TransactionAndMetadata > data::BackendInterface::fetchAllTransactionsInLedger	(	std::uint32_t	ledgerSequence,
		boost::asio::yield_context	yield ) const

pure virtual

Fetches all transactions from a specific ledger.

Parameters

ledgerSequence	The ledger sequence to fetch for
yield	The coroutine context

Returns: Results as a vector of TransactionAndMetadata

◆ fetchBookOffers()

BookOffersPage data::BackendInterface::fetchBookOffers	(	ripple::uint256 const &	book,
		std::uint32_t	ledgerSequence,
		std::uint32_t	limit,
		boost::asio::yield_context	yield ) const

Fetches book offers.

Parameters

book	Unsigned 256-bit integer.
ledgerSequence	The ledger sequence to fetch for
limit	Pagaing limit as to how many transactions returned per page.
yield	The coroutine context

Returns: The book offers page

◆ fetchClioNodesData()

virtual ClioNodesDataFetchResult data::BackendInterface::fetchClioNodesData ( boost::asio::yield_context yield ) const

nodiscardpure virtual

Fetches the data of all nodes in the cluster.

Parameters

yield The coroutine context

Returns: The data of all nodes in the cluster.

◆ fetchFees()

std::optional< ripple::Fees > data::BackendInterface::fetchFees	(	std::uint32_t	seq,
		boost::asio::yield_context	yield ) const

Fetch the fees from a specific ledger sequence.

Parameters

seq	The sequence to fetch for
yield	The coroutine context

Returns: Fees if fees are found; nullopt otherwise

◆ fetchLatestLedgerSequence()

virtual std::optional< std::uint32_t > data::BackendInterface::fetchLatestLedgerSequence ( boost::asio::yield_context yield ) const

pure virtual

Fetches the latest ledger sequence.

Parameters

yield The coroutine context

Returns: Latest sequence wrapped in an optional if found; nullopt otherwise

◆ fetchLedgerByHash()

virtual std::optional< ripple::LedgerHeader > data::BackendInterface::fetchLedgerByHash	(	ripple::uint256 const &	hash,
		boost::asio::yield_context	yield ) const

pure virtual

Fetches a specific ledger by hash.

Parameters

hash	The hash to fetch for
yield	The coroutine context

Returns: The ripple::LedgerHeader if found; nullopt otherwise

◆ fetchLedgerBySequence()

virtual std::optional< ripple::LedgerHeader > data::BackendInterface::fetchLedgerBySequence	(	std::uint32_t	sequence,
		boost::asio::yield_context	yield ) const

pure virtual

Fetches a specific ledger by sequence number.

Parameters

sequence	The sequence number to fetch for
yield	The coroutine context

Returns: The ripple::LedgerHeader if found; nullopt otherwise

◆ fetchLedgerDiff()

virtual std::vector< LedgerObject > data::BackendInterface::fetchLedgerDiff	(	std::uint32_t	ledgerSequence,
		boost::asio::yield_context	yield ) const

pure virtual

Returns the difference between ledgers.

Parameters

ledgerSequence	The ledger sequence to fetch for
yield	The coroutine context

Returns: A vector of LedgerObject representing the diff

◆ fetchLedgerObject()

std::optional< Blob > data::BackendInterface::fetchLedgerObject	(	ripple::uint256 const &	key,
		std::uint32_t	sequence,
		boost::asio::yield_context	yield ) const

Fetches a specific ledger object.

Currently the real fetch happens in doFetchLedgerObject and fetchLedgerObject attempts to fetch from Cache first and only calls out to the real DB if a cache miss occurred.

Parameters

key	The key of the object
sequence	The ledger sequence to fetch for
yield	The coroutine context

Returns: The object as a Blob on success; nullopt otherwise

◆ fetchLedgerObjects()

std::vector< Blob > data::BackendInterface::fetchLedgerObjects	(	std::vector< ripple::uint256 > const &	keys,
		std::uint32_t	sequence,
		boost::asio::yield_context	yield ) const

Fetches all ledger objects by their keys.

Currently the real fetch happens in doFetchLedgerObjects and fetchLedgerObjects attempts to fetch from Cache first and only calls out to the real DB for each of the keys that was not found in the cache.

Parameters

keys	A vector with the keys of the objects to fetch
sequence	The ledger sequence to fetch for
yield	The coroutine context

Returns: A vector of ledger objects as Blobs

◆ fetchLedgerObjectSeq()

std::optional< std::uint32_t > data::BackendInterface::fetchLedgerObjectSeq	(	ripple::uint256 const &	key,
		std::uint32_t	sequence,
		boost::asio::yield_context	yield ) const

Fetches a specific ledger object sequence.

Currently the real fetch happens in doFetchLedgerObjectSeq

Parameters

key	The key of the object
sequence	The ledger sequence to fetch for
yield	The coroutine context

Returns: The sequence in unit32_t on success; nullopt otherwise

◆ fetchLedgerPage()

LedgerPage data::BackendInterface::fetchLedgerPage	(	std::optional< ripple::uint256 > const &	cursor,
		std::uint32_t	ledgerSequence,
		std::uint32_t	limit,
		bool	outOfOrder,
		boost::asio::yield_context	yield )

Fetches a page of ledger objects, ordered by key/index.

Parameters

cursor	The cursor to resume fetching from
ledgerSequence	The ledger sequence to fetch for
limit	The maximum number of transactions per result page
outOfOrder	If set to true max available sequence is used instead of ledgerSequence
yield	The coroutine context

Returns: The ledger page

◆ fetchLedgerRange()

std::optional< LedgerRange > data::BackendInterface::fetchLedgerRange ( ) const

Fetch the current ledger range.

Returns: The current ledger range if populated; nullopt otherwise

◆ fetchMigratorStatus()

virtual std::optional< std::string > data::BackendInterface::fetchMigratorStatus	(	std::string const &	migratorName,
		boost::asio::yield_context	yield ) const

pure virtual

Fetches the status of migrator by name.

Parameters

migratorName	The name of the migrator
yield	The coroutine context

Returns: The status of the migrator if found; nullopt otherwise

◆ fetchMPTHolders()

virtual MPTHoldersAndCursor data::BackendInterface::fetchMPTHolders	(	ripple::uint192 const &	mptID,
		std::uint32_t const	limit,
		std::optional< ripple::AccountID > const &	cursorIn,
		std::uint32_t const	ledgerSequence,
		boost::asio::yield_context	yield ) const

pure virtual

Fetches all holders' balances for a MPTIssuanceID.

Parameters

mptID	MPTIssuanceID you wish you query.
limit	Paging limit.
cursorIn	Optional cursor to allow us to pick up from where we last left off.
ledgerSequence	The ledger sequence to fetch for
yield	Currently executing coroutine.

Returns: std::vector<Blob> of MPToken balances and an optional marker

◆ fetchNFT()

virtual std::optional< NFT > data::BackendInterface::fetchNFT	(	ripple::uint256 const &	tokenID,
		std::uint32_t	ledgerSequence,
		boost::asio::yield_context	yield ) const

pure virtual

Fetches a specific NFT.

Parameters

tokenID	The ID of the NFT
ledgerSequence	The ledger sequence to fetch for
yield	The coroutine context

Returns: NFT object on success; nullopt otherwise

◆ fetchNFTsByIssuer()

virtual NFTsAndCursor data::BackendInterface::fetchNFTsByIssuer	(	ripple::AccountID const &	issuer,
		std::optional< std::uint32_t > const &	taxon,
		std::uint32_t	ledgerSequence,
		std::uint32_t	limit,
		std::optional< ripple::uint256 > const &	cursorIn,
		boost::asio::yield_context	yield ) const

pure virtual

Fetches all NFTs issued by a given address.

Parameters

issuer	AccountID of issuer you wish you query.
taxon	Optional taxon of NFTs by which you wish to filter.
ledgerSequence	The ledger sequence to fetch for
limit	Paging limit.
cursorIn	Optional cursor to allow us to pick up from where we last left off.
yield	Currently executing coroutine.

Returns: NFTs issued by this account, or this issuer/taxon combination if taxon is passed and an optional marker

Implemented in data::cassandra::BasicCassandraBackend< SettingsProviderType, ExecutionStrategyType, FetchLedgerCacheType >, data::cassandra::BasicCassandraBackend< SettingsProvider, impl::DefaultExecutionStrategy<> >, data::cassandra::BasicKeyspaceBackend< SettingsProviderType, ExecutionStrategyType, FetchLedgerCacheType >, and data::cassandra::BasicKeyspaceBackend< SettingsProvider, impl::DefaultExecutionStrategy<> >.

◆ fetchNFTTransactions()

virtual TransactionsAndCursor data::BackendInterface::fetchNFTTransactions	(	ripple::uint256 const &	tokenID,
		std::uint32_t	limit,
		bool	forward,
		std::optional< TransactionsCursor > const &	cursorIn,
		boost::asio::yield_context	yield ) const

pure virtual

Fetches all transactions for a specific NFT.

Parameters

tokenID	The ID of the NFT
limit	The maximum number of transactions per result page
forward	Whether to fetch the page forwards or backwards from the given cursor
cursorIn	The cursor to resume fetching from
yield	The coroutine context

Returns: Results and a cursor to resume from

◆ fetchSuccessorKey()

std::optional< ripple::uint256 > data::BackendInterface::fetchSuccessorKey	(	ripple::uint256	key,
		std::uint32_t	ledgerSequence,
		boost::asio::yield_context	yield ) const

Fetches the successor key.

Thea real fetch happens in doFetchSuccessorKey. This function will attempt to lookup the successor in the cache first and only if it's not found in the cache will it fetch from the actual DB.

Parameters

key	The key to fetch for
ledgerSequence	The ledger sequence to fetch for
yield	The coroutine context

Returns: The successor key on success; nullopt otherwise

◆ fetchSuccessorObject()

std::optional< LedgerObject > data::BackendInterface::fetchSuccessorObject	(	ripple::uint256	key,
		std::uint32_t	ledgerSequence,
		boost::asio::yield_context	yield ) const

Fetches the successor object.

Parameters

key	The key to fetch for
ledgerSequence	The ledger sequence to fetch for
yield	The coroutine context

Returns: The successor on success; nullopt otherwise

◆ fetchTransaction()

virtual std::optional< TransactionAndMetadata > data::BackendInterface::fetchTransaction	(	ripple::uint256 const &	hash,
		boost::asio::yield_context	yield ) const

pure virtual

Fetches a specific transaction.

Parameters

hash	The hash of the transaction to fetch
yield	The coroutine context

Returns: TransactionAndMetadata if transaction is found; nullopt otherwise

◆ fetchTransactions()

virtual std::vector< TransactionAndMetadata > data::BackendInterface::fetchTransactions	(	std::vector< ripple::uint256 > const &	hashes,
		boost::asio::yield_context	yield ) const

pure virtual

Fetches multiple transactions.

Parameters

hashes	A vector of hashes to fetch transactions for
yield	The coroutine context

Returns: A vector of TransactionAndMetadata matching the given hashes

◆ finishWrites()

bool data::BackendInterface::finishWrites ( std::uint32_t ledgerSequence )

Tells database we finished writing all data for a specific ledger.

Uses doFinishWrites to synchronize with the pending writes.

Parameters

ledgerSequence The ledger sequence to finish writing for

Returns: true on success; false otherwise

◆ hardFetchLedgerRange() [1/2]

std::optional< LedgerRange > data::BackendInterface::hardFetchLedgerRange ( ) const

Synchronously fetches the ledger range from DB.

This function just wraps hardFetchLedgerRange(boost::asio::yield_context) using synchronous(FnType&&).

Returns: The ledger range if available; nullopt otherwise

◆ hardFetchLedgerRange() [2/2]

virtual std::optional< LedgerRange > data::BackendInterface::hardFetchLedgerRange ( boost::asio::yield_context yield ) const

pure virtual

Fetches the ledger range from DB.

Parameters

yield The coroutine context

Returns: The ledger range if available; nullopt otherwise

◆ hardFetchLedgerRangeNoThrow()

std::optional< LedgerRange > data::BackendInterface::hardFetchLedgerRangeNoThrow ( ) const

Fetches the ledger range from DB retrying until no DatabaseTimeout is thrown.

Returns: The ledger range if available; nullopt otherwise

◆ isTooBusy()

virtual bool data::BackendInterface::isTooBusy ( ) const

pure virtual

Returns: true if database is overwhelmed; false otherwise

◆ setCorruptionDetector()

void data::BackendInterface::setCorruptionDetector ( etl::CorruptionDetector detector )

inline

Sets the corruption detector.

Parameters

detector The corruption detector to set

◆ setRange()

void data::BackendInterface::setRange	(	uint32_t	min,
		uint32_t	max,
		bool	force = false )

Sets the range of sequences that are stored in the DB.

Parameters

min	The new minimum sequence available
max	The new maximum sequence available
force	If set to true, the range will be set even if it's already set

◆ startWrites()

virtual void data::BackendInterface::startWrites ( ) const

pure virtual

Starts a write transaction with the DB. No-op for cassandra.

Note: Can potentially be deprecated and removed.

◆ stats()

virtual boost::json::object data::BackendInterface::stats ( ) const

pure virtual

Returns: A JSON object containing backend usage statistics

◆ updateRange()

void data::BackendInterface::updateRange ( uint32_t newMax )

Updates the range of sequences that are stored in the DB.

Parameters

newMax The new maximum sequence available

◆ waitForWritesToFinish()

virtual void data::BackendInterface::waitForWritesToFinish ( )

pure virtual

Wait for all pending writes to finish.

◆ writeAccountTransaction()

virtual void data::BackendInterface::writeAccountTransaction ( AccountTransactionsData record )

pure virtual

Write a new account transaction.

Parameters

record An object representing the account transaction

◆ writeAccountTransactions()

virtual void data::BackendInterface::writeAccountTransactions ( std::vector< AccountTransactionsData > data )

pure virtual

Write a new set of account transactions.

Parameters

data	A vector of AccountTransactionsData objects representing the account transactions

◆ writeLedger()

virtual void data::BackendInterface::writeLedger	(	ripple::LedgerHeader const &	ledgerHeader,
		std::string &&	blob )

pure virtual

Writes to a specific ledger.

Parameters

ledgerHeader	Ledger header.
blob	r-value string serialization of ledger header.

◆ writeLedgerObject()

void data::BackendInterface::writeLedgerObject	(	std::string &&	key,
		std::uint32_t	seq,
		std::string &&	blob )

virtual

Writes a new ledger object.

Parameters

key	The key to write the ledger object under
seq	The ledger sequence to write for
blob	The data to write

◆ writeMigratorStatus()

virtual void data::BackendInterface::writeMigratorStatus	(	std::string const &	migratorName,
		std::string const &	status )

pure virtual

Mark the migration status of a migrator as Migrated in the database.

Parameters

migratorName	The name of the migrator
status	The status to set

◆ writeMPTHolders()

virtual void data::BackendInterface::writeMPTHolders ( std::vector< MPTHolderData > const & data )

pure virtual

Write accounts that started holding onto a MPT.

Parameters

data	A vector of MPT ID and account pairs

◆ writeNFTs()

virtual void data::BackendInterface::writeNFTs ( std::vector< NFTsData > const & data )

pure virtual

Writes NFTs to the database.

Parameters

data	A vector of NFTsData objects representing the NFTs

◆ writeNFTTransactions()

virtual void data::BackendInterface::writeNFTTransactions ( std::vector< NFTTransactionsData > const & data )

pure virtual

Write NFTs transactions.

Parameters

data	A vector of NFTTransactionsData objects

◆ writeNodeMessage()

virtual void data::BackendInterface::writeNodeMessage	(	boost::uuids::uuid const &	uuid,
		std::string	message )

pure virtual

Write a node message. Used by ClusterCommunicationService.

Parameters

uuid	The UUID of the node
message	The message to write

◆ writeSuccessor()

virtual void data::BackendInterface::writeSuccessor	(	std::string &&	key,
		std::uint32_t	seq,
		std::string &&	successor )

pure virtual

Write a new successor.

Parameters

key	Key of the object that the passed successor will be the successor for
seq	The ledger sequence to write for
successor	The successor data to write

◆ writeTransaction()

virtual void data::BackendInterface::writeTransaction	(	std::string &&	hash,
		std::uint32_t	seq,
		std::uint32_t	date,
		std::string &&	transaction,
		std::string &&	metadata )

pure virtual

Writes a new transaction.

Parameters

hash	The hash of the transaction
seq	The ledger sequence to write for
date	The timestamp of the entry
transaction	The transaction data to write
metadata	The metadata to write

The documentation for this class was generated from the following files:

/__w/clio/clio/src/data/BackendInterface.hpp
/__w/clio/clio/src/data/BackendInterface.cpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ClioNodesDataFetchResult

Constructor & Destructor Documentation

◆ BackendInterface()

Member Function Documentation

◆ cache() [1/2]

◆ cache() [2/2]

◆ doFetchLedgerObject()

◆ doFetchLedgerObjects()

◆ doFetchLedgerObjectSeq()

◆ doFetchSuccessorKey()

◆ fetchAccountRoots()

◆ fetchAccountTransactions()

◆ fetchAllTransactionHashesInLedger()

◆ fetchAllTransactionsInLedger()

◆ fetchBookOffers()

◆ fetchClioNodesData()

◆ fetchFees()

◆ fetchLatestLedgerSequence()

◆ fetchLedgerByHash()

◆ fetchLedgerBySequence()

◆ fetchLedgerDiff()

◆ fetchLedgerObject()

◆ fetchLedgerObjects()

◆ fetchLedgerObjectSeq()

◆ fetchLedgerPage()

◆ fetchLedgerRange()

◆ fetchMigratorStatus()

◆ fetchMPTHolders()

◆ fetchNFT()

◆ fetchNFTsByIssuer()

◆ fetchNFTTransactions()

◆ fetchSuccessorKey()

◆ fetchSuccessorObject()

◆ fetchTransaction()

◆ fetchTransactions()

◆ finishWrites()

◆ hardFetchLedgerRange() [1/2]

◆ hardFetchLedgerRange() [2/2]

◆ hardFetchLedgerRangeNoThrow()

◆ isTooBusy()

◆ setCorruptionDetector()

◆ setRange()

◆ startWrites()

◆ stats()

◆ updateRange()

◆ waitForWritesToFinish()

◆ writeAccountTransaction()

◆ writeAccountTransactions()

◆ writeLedger()

◆ writeLedgerObject()

◆ writeMigratorStatus()

◆ writeMPTHolders()

◆ writeNFTs()

◆ writeNFTTransactions()

◆ writeNodeMessage()

◆ writeSuccessor()

◆ writeTransaction()