mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-24 04:55:52 +00:00
1154 lines
72 KiB
HTML
1154 lines
72 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: ripple::PostgresDatabase Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1PostgresDatabase.html">PostgresDatabase</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="classripple_1_1PostgresDatabase-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ripple::PostgresDatabase Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="dynheader">
|
|
Inheritance diagram for ripple::PostgresDatabase:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1PostgresDatabase__inherit__graph.png" border="0" usemap="#ripple_1_1PostgresDatabase_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="ripple_1_1PostgresDatabase_inherit__map" id="ripple_1_1PostgresDatabase_inherit__map">
|
|
<area shape="rect" title=" " alt="" coords="18,80,203,107"/>
|
|
<area shape="rect" href="classripple_1_1PostgresDatabaseImp.html" title=" " alt="" coords="5,155,216,181"/>
|
|
<area shape="rect" href="classripple_1_1RelationalDatabase.html" title=" " alt="" coords="13,5,208,32"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ripple::PostgresDatabase:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1PostgresDatabase__coll__graph.png" border="0" usemap="#ripple_1_1PostgresDatabase_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="ripple_1_1PostgresDatabase_coll__map" id="ripple_1_1PostgresDatabase_coll__map">
|
|
<area shape="rect" title=" " alt="" coords="10,80,195,107"/>
|
|
<area shape="rect" href="classripple_1_1RelationalDatabase.html" title=" " alt="" coords="5,5,200,32"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a251e55e3d5aa9b4e4d1a7eebe2157d46"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a251e55e3d5aa9b4e4d1a7eebe2157d46">AccountTx</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1Transaction.html">Transaction</a> >, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1TxMeta.html">TxMeta</a> > ></td></tr>
|
|
<tr class="separator:a251e55e3d5aa9b4e4d1a7eebe2157d46"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1af9139d7f4c8f662c7b8e49473a21e2"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a1af9139d7f4c8f662c7b8e49473a21e2">AccountTxs</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>< <a class="el" href="classripple_1_1RelationalDatabase.html#a251e55e3d5aa9b4e4d1a7eebe2157d46">AccountTx</a> ></td></tr>
|
|
<tr class="separator:a1af9139d7f4c8f662c7b8e49473a21e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad49d721f8f069c1ee9652b93a3485423"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#ad49d721f8f069c1ee9652b93a3485423">txnMetaLedgerType</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/tuple.html">std::tuple</a>< <a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a>, <a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ></td></tr>
|
|
<tr class="separator:ad49d721f8f069c1ee9652b93a3485423"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a183ed7f35d368ec4564d8083fe9656f3"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a183ed7f35d368ec4564d8083fe9656f3">MetaTxsList</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>< <a class="el" href="classripple_1_1RelationalDatabase.html#ad49d721f8f069c1ee9652b93a3485423">txnMetaLedgerType</a> ></td></tr>
|
|
<tr class="separator:a183ed7f35d368ec4564d8083fe9656f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:affdfbc3c5f0f2d7b78cc5570617a5fda"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#affdfbc3c5f0f2d7b78cc5570617a5fda">LedgerSequence</a> = uint32_t</td></tr>
|
|
<tr class="separator:affdfbc3c5f0f2d7b78cc5570617a5fda"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae6ed6a653c43698a1480c0230b1e99aa"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#ae6ed6a653c43698a1480c0230b1e99aa">LedgerHash</a> = <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a></td></tr>
|
|
<tr class="separator:ae6ed6a653c43698a1480c0230b1e99aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99c471461c2b0858d240f98034c6fda3"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a99c471461c2b0858d240f98034c6fda3">LedgerShortcut</a> = <a class="el" href="namespaceripple_1_1RPC.html#a4c04e509451d50d9449cff3d477ff4f2">RPC::LedgerShortcut</a></td></tr>
|
|
<tr class="separator:a99c471461c2b0858d240f98034c6fda3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae6edb30f534bd5669ee659789aa22e86"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#ae6edb30f534bd5669ee659789aa22e86">LedgerSpecifier</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/variant.html">std::variant</a>< <a class="el" href="structripple_1_1LedgerRange.html">LedgerRange</a>, <a class="el" href="namespaceripple_1_1RPC.html#a4c04e509451d50d9449cff3d477ff4f2">LedgerShortcut</a>, <a class="el" href="classripple_1_1RelationalDatabase.html#affdfbc3c5f0f2d7b78cc5570617a5fda">LedgerSequence</a>, <a class="el" href="classripple_1_1RelationalDatabase.html#ae6ed6a653c43698a1480c0230b1e99aa">LedgerHash</a> ></td></tr>
|
|
<tr class="separator:ae6edb30f534bd5669ee659789aa22e86"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a777dd8559a055cca317f9525694be1c4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1PostgresDatabase.html#a777dd8559a055cca317f9525694be1c4">stop</a> ()=0</td></tr>
|
|
<tr class="separator:a777dd8559a055cca317f9525694be1c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad14da01d1b10dbcc73c16b729ed67b1a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1PostgresDatabase.html#ad14da01d1b10dbcc73c16b729ed67b1a">sweep</a> ()=0</td></tr>
|
|
<tr class="memdesc:ad14da01d1b10dbcc73c16b729ed67b1a"><td class="mdescLeft"> </td><td class="mdescRight">sweep Sweeps the database. <a href="classripple_1_1PostgresDatabase.html#ad14da01d1b10dbcc73c16b729ed67b1a">More...</a><br /></td></tr>
|
|
<tr class="separator:ad14da01d1b10dbcc73c16b729ed67b1a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a638a2672a99fd56dc7c534a65de82422"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1PostgresDatabase.html#a638a2672a99fd56dc7c534a65de82422">getCompleteLedgers</a> ()=0</td></tr>
|
|
<tr class="memdesc:a638a2672a99fd56dc7c534a65de82422"><td class="mdescLeft"> </td><td class="mdescRight">getCompleteLedgers Returns a string which contains a list of completed ledgers. <a href="classripple_1_1PostgresDatabase.html#a638a2672a99fd56dc7c534a65de82422">More...</a><br /></td></tr>
|
|
<tr class="separator:a638a2672a99fd56dc7c534a65de82422"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acbad8709817f45cb6879fd6bbb8168d9"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1PostgresDatabase.html#acbad8709817f45cb6879fd6bbb8168d9">getValidatedLedgerAge</a> ()=0</td></tr>
|
|
<tr class="memdesc:acbad8709817f45cb6879fd6bbb8168d9"><td class="mdescLeft"> </td><td class="mdescRight">getValidatedLedgerAge Returns the age of the last validated ledger. <a href="classripple_1_1PostgresDatabase.html#acbad8709817f45cb6879fd6bbb8168d9">More...</a><br /></td></tr>
|
|
<tr class="separator:acbad8709817f45cb6879fd6bbb8168d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a80ccf4e291a450fb7dda321479677e32"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1PostgresDatabase.html#a80ccf4e291a450fb7dda321479677e32">writeLedgerAndTransactions</a> (<a class="el" href="structripple_1_1LedgerInfo.html">LedgerInfo</a> const &info, <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>< <a class="el" href="structripple_1_1RelationalDatabase_1_1AccountTransactionsData.html">AccountTransactionsData</a> > const &accountTxData)=0</td></tr>
|
|
<tr class="memdesc:a80ccf4e291a450fb7dda321479677e32"><td class="mdescLeft"> </td><td class="mdescRight">writeLedgerAndTransactions Writes new ledger and transaction data into the database. <a href="classripple_1_1PostgresDatabase.html#a80ccf4e291a450fb7dda321479677e32">More...</a><br /></td></tr>
|
|
<tr class="separator:a80ccf4e291a450fb7dda321479677e32"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a784583e95d607018791e7073784bd04d"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>< <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1PostgresDatabase.html#a784583e95d607018791e7073784bd04d">getTxHashes</a> (<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> seq)=0</td></tr>
|
|
<tr class="memdesc:a784583e95d607018791e7073784bd04d"><td class="mdescLeft"> </td><td class="mdescRight">getTxHashes Returns a vector of the hashes of transactions belonging to the ledger with the provided sequence. <a href="classripple_1_1PostgresDatabase.html#a784583e95d607018791e7073784bd04d">More...</a><br /></td></tr>
|
|
<tr class="separator:a784583e95d607018791e7073784bd04d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af006b47c3c1caa59cc062700a4d41741"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="structripple_1_1RelationalDatabase_1_1AccountTxResult.html">AccountTxResult</a>, <a class="el" href="structripple_1_1RPC_1_1Status.html">RPC::Status</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1PostgresDatabase.html#af006b47c3c1caa59cc062700a4d41741">getAccountTx</a> (<a class="el" href="structripple_1_1RelationalDatabase_1_1AccountTxArgs.html">AccountTxArgs</a> const &args)=0</td></tr>
|
|
<tr class="memdesc:af006b47c3c1caa59cc062700a4d41741"><td class="mdescLeft"> </td><td class="mdescRight">getAccountTx Get the last account transactions specified by the AccountTxArgs struct. <a href="classripple_1_1PostgresDatabase.html#af006b47c3c1caa59cc062700a4d41741">More...</a><br /></td></tr>
|
|
<tr class="separator:af006b47c3c1caa59cc062700a4d41741"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7ba9f944c4586b5b93018d828ace12b8"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structripple_1_1Transaction_1_1Locator.html">Transaction::Locator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1PostgresDatabase.html#a7ba9f944c4586b5b93018d828ace12b8">locateTransaction</a> (<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &id)=0</td></tr>
|
|
<tr class="memdesc:a7ba9f944c4586b5b93018d828ace12b8"><td class="mdescLeft"> </td><td class="mdescRight">locateTransaction Returns information used to locate a transaction. <a href="classripple_1_1PostgresDatabase.html#a7ba9f944c4586b5b93018d828ace12b8">More...</a><br /></td></tr>
|
|
<tr class="separator:a7ba9f944c4586b5b93018d828ace12b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeff0aabad25764e5b7bd22acfd9c3a82"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1PostgresDatabase.html#aeff0aabad25764e5b7bd22acfd9c3a82">isCaughtUp</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> &reason)=0</td></tr>
|
|
<tr class="memdesc:aeff0aabad25764e5b7bd22acfd9c3a82"><td class="mdescLeft"> </td><td class="mdescRight">isCaughtUp returns whether the database is caught up with the network <a href="classripple_1_1PostgresDatabase.html#aeff0aabad25764e5b7bd22acfd9c3a82">More...</a><br /></td></tr>
|
|
<tr class="separator:aeff0aabad25764e5b7bd22acfd9c3a82"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0075f77f85eb16d36fdd35974acfb8ea"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a0075f77f85eb16d36fdd35974acfb8ea">getMinLedgerSeq</a> ()=0</td></tr>
|
|
<tr class="memdesc:a0075f77f85eb16d36fdd35974acfb8ea"><td class="mdescLeft"> </td><td class="mdescRight">getMinLedgerSeq Returns the minimum ledger sequence in the Ledgers table. <a href="classripple_1_1RelationalDatabase.html#a0075f77f85eb16d36fdd35974acfb8ea">More...</a><br /></td></tr>
|
|
<tr class="separator:a0075f77f85eb16d36fdd35974acfb8ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4e757a2656cd3c537e997e8a67ee78a"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#aa4e757a2656cd3c537e997e8a67ee78a">getMaxLedgerSeq</a> ()=0</td></tr>
|
|
<tr class="memdesc:aa4e757a2656cd3c537e997e8a67ee78a"><td class="mdescLeft"> </td><td class="mdescRight">getMaxLedgerSeq Returns the maximum ledger sequence in the Ledgers table. <a href="classripple_1_1RelationalDatabase.html#aa4e757a2656cd3c537e997e8a67ee78a">More...</a><br /></td></tr>
|
|
<tr class="separator:aa4e757a2656cd3c537e997e8a67ee78a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b67ba7e09ea642386597210efefe07d"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="structripple_1_1LedgerInfo.html">LedgerInfo</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a4b67ba7e09ea642386597210efefe07d">getLedgerInfoByIndex</a> (<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> ledgerSeq)=0</td></tr>
|
|
<tr class="memdesc:a4b67ba7e09ea642386597210efefe07d"><td class="mdescLeft"> </td><td class="mdescRight">getLedgerInfoByIndex Returns a ledger by its sequence. <a href="classripple_1_1RelationalDatabase.html#a4b67ba7e09ea642386597210efefe07d">More...</a><br /></td></tr>
|
|
<tr class="separator:a4b67ba7e09ea642386597210efefe07d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acbc9c19a6c01c6004df183ed8858f88b"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="structripple_1_1LedgerInfo.html">LedgerInfo</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#acbc9c19a6c01c6004df183ed8858f88b">getNewestLedgerInfo</a> ()=0</td></tr>
|
|
<tr class="memdesc:acbc9c19a6c01c6004df183ed8858f88b"><td class="mdescLeft"> </td><td class="mdescRight">getNewestLedgerInfo Returns the info of the newest saved ledger. <a href="classripple_1_1RelationalDatabase.html#acbc9c19a6c01c6004df183ed8858f88b">More...</a><br /></td></tr>
|
|
<tr class="separator:acbc9c19a6c01c6004df183ed8858f88b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2df06f73b03baa40ff0cc92066d9fd3b"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="structripple_1_1LedgerInfo.html">LedgerInfo</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a2df06f73b03baa40ff0cc92066d9fd3b">getLedgerInfoByHash</a> (<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &ledgerHash)=0</td></tr>
|
|
<tr class="memdesc:a2df06f73b03baa40ff0cc92066d9fd3b"><td class="mdescLeft"> </td><td class="mdescRight">getLedgerInfoByHash Returns the info of the ledger with given hash. <a href="classripple_1_1RelationalDatabase.html#a2df06f73b03baa40ff0cc92066d9fd3b">More...</a><br /></td></tr>
|
|
<tr class="separator:a2df06f73b03baa40ff0cc92066d9fd3b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae73b0356cc96e29c9c66e52f64aeac0d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#ae73b0356cc96e29c9c66e52f64aeac0d">getHashByIndex</a> (<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> ledgerIndex)=0</td></tr>
|
|
<tr class="memdesc:ae73b0356cc96e29c9c66e52f64aeac0d"><td class="mdescLeft"> </td><td class="mdescRight">getHashByIndex Returns the hash of the ledger with the given sequence. <a href="classripple_1_1RelationalDatabase.html#ae73b0356cc96e29c9c66e52f64aeac0d">More...</a><br /></td></tr>
|
|
<tr class="separator:ae73b0356cc96e29c9c66e52f64aeac0d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a177aaf55106410ac5a2b2969674d4d57"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="structripple_1_1LedgerHashPair.html">LedgerHashPair</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a177aaf55106410ac5a2b2969674d4d57">getHashesByIndex</a> (<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> ledgerIndex)=0</td></tr>
|
|
<tr class="memdesc:a177aaf55106410ac5a2b2969674d4d57"><td class="mdescLeft"> </td><td class="mdescRight">getHashesByIndex Returns the hashes of the ledger and its parent as specified by the ledgerIndex. <a href="classripple_1_1RelationalDatabase.html#a177aaf55106410ac5a2b2969674d4d57">More...</a><br /></td></tr>
|
|
<tr class="separator:a177aaf55106410ac5a2b2969674d4d57"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d01c850566c044f3d595db5b16cc7c0"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/container/map.html">std::map</a>< <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a>, <a class="el" href="structripple_1_1LedgerHashPair.html">LedgerHashPair</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a4d01c850566c044f3d595db5b16cc7c0">getHashesByIndex</a> (<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> minSeq, <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> maxSeq)=0</td></tr>
|
|
<tr class="memdesc:a4d01c850566c044f3d595db5b16cc7c0"><td class="mdescLeft"> </td><td class="mdescRight">getHashesByIndex Returns hashes of each ledger and its parent for all ledgers within the provided range. <a href="classripple_1_1RelationalDatabase.html#a4d01c850566c044f3d595db5b16cc7c0">More...</a><br /></td></tr>
|
|
<tr class="separator:a4d01c850566c044f3d595db5b16cc7c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae6c8de0e4ae5d6b0ad97d0ac219196d5"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1Transaction.html">Transaction</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#ae6c8de0e4ae5d6b0ad97d0ac219196d5">getTxHistory</a> (<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> startIndex)=0</td></tr>
|
|
<tr class="memdesc:ae6c8de0e4ae5d6b0ad97d0ac219196d5"><td class="mdescLeft"> </td><td class="mdescRight">getTxHistory Returns the 20 most recent transactions starting from the given number. <a href="classripple_1_1RelationalDatabase.html#ae6c8de0e4ae5d6b0ad97d0ac219196d5">More...</a><br /></td></tr>
|
|
<tr class="separator:ae6c8de0e4ae5d6b0ad97d0ac219196d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d4e0e3c03536c80901f72355139a483"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a7d4e0e3c03536c80901f72355139a483">ledgerDbHasSpace</a> (<a class="el" href="classripple_1_1Config.html">Config</a> const &config)=0</td></tr>
|
|
<tr class="memdesc:a7d4e0e3c03536c80901f72355139a483"><td class="mdescLeft"> </td><td class="mdescRight">ledgerDbHasSpace Checks if the ledger database has available space. <a href="classripple_1_1RelationalDatabase.html#a7d4e0e3c03536c80901f72355139a483">More...</a><br /></td></tr>
|
|
<tr class="separator:a7d4e0e3c03536c80901f72355139a483"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59c527306560ba3cf9d774fc73ee29a4"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a59c527306560ba3cf9d774fc73ee29a4">transactionDbHasSpace</a> (<a class="el" href="classripple_1_1Config.html">Config</a> const &config)=0</td></tr>
|
|
<tr class="memdesc:a59c527306560ba3cf9d774fc73ee29a4"><td class="mdescLeft"> </td><td class="mdescRight">transactionDbHasSpace Checks if the transaction database has available space. <a href="classripple_1_1RelationalDatabase.html#a59c527306560ba3cf9d774fc73ee29a4">More...</a><br /></td></tr>
|
|
<tr class="separator:a59c527306560ba3cf9d774fc73ee29a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a7f08e20557d394e761662ff29373f467"><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< <a class="el" href="classripple_1_1RelationalDatabase.html">RelationalDatabase</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a7f08e20557d394e761662ff29373f467">init</a> (<a class="el" href="classripple_1_1Application.html">Application</a> &app, <a class="el" href="classripple_1_1Config.html">Config</a> const &config, <a class="el" href="classripple_1_1JobQueue.html">JobQueue</a> &jobQueue)</td></tr>
|
|
<tr class="memdesc:a7f08e20557d394e761662ff29373f467"><td class="mdescLeft"> </td><td class="mdescRight">init Creates and returns an appropriate <a class="el" href="classripple_1_1RelationalDatabase.html">RelationalDatabase</a> instance based on configuration. <a href="classripple_1_1RelationalDatabase.html#a7f08e20557d394e761662ff29373f467">More...</a><br /></td></tr>
|
|
<tr class="separator:a7f08e20557d394e761662ff29373f467"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock">
|
|
<p class="definition">Definition at line <a class="el" href="PostgresDatabase_8h_source.html#l00027">27</a> of file <a class="el" href="PostgresDatabase_8h_source.html">PostgresDatabase.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="a251e55e3d5aa9b4e4d1a7eebe2157d46"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a251e55e3d5aa9b4e4d1a7eebe2157d46">◆ </a></span>AccountTx</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1RelationalDatabase.html#a251e55e3d5aa9b4e4d1a7eebe2157d46">ripple::RelationalDatabase::AccountTx</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a><<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a><<a class="el" href="classripple_1_1Transaction.html">Transaction</a>>, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a><<a class="el" href="classripple_1_1TxMeta.html">TxMeta</a>> ></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8h_source.html#l00085">85</a> of file <a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1af9139d7f4c8f662c7b8e49473a21e2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1af9139d7f4c8f662c7b8e49473a21e2">◆ </a></span>AccountTxs</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1RelationalDatabase.html#a1af9139d7f4c8f662c7b8e49473a21e2">ripple::RelationalDatabase::AccountTxs</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a><<a class="el" href="classripple_1_1RelationalDatabase.html#a251e55e3d5aa9b4e4d1a7eebe2157d46">AccountTx</a>></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8h_source.html#l00086">86</a> of file <a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad49d721f8f069c1ee9652b93a3485423"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad49d721f8f069c1ee9652b93a3485423">◆ </a></span>txnMetaLedgerType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1RelationalDatabase.html#ad49d721f8f069c1ee9652b93a3485423">ripple::RelationalDatabase::txnMetaLedgerType</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/tuple.html">std::tuple</a><<a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a>, <a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8h_source.html#l00087">87</a> of file <a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a183ed7f35d368ec4564d8083fe9656f3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a183ed7f35d368ec4564d8083fe9656f3">◆ </a></span>MetaTxsList</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1RelationalDatabase.html#a183ed7f35d368ec4564d8083fe9656f3">ripple::RelationalDatabase::MetaTxsList</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a><<a class="el" href="classripple_1_1RelationalDatabase.html#ad49d721f8f069c1ee9652b93a3485423">txnMetaLedgerType</a>></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8h_source.html#l00088">88</a> of file <a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="affdfbc3c5f0f2d7b78cc5570617a5fda"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#affdfbc3c5f0f2d7b78cc5570617a5fda">◆ </a></span>LedgerSequence</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1RelationalDatabase.html#affdfbc3c5f0f2d7b78cc5570617a5fda">ripple::RelationalDatabase::LedgerSequence</a> = uint32_t</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8h_source.html#l00090">90</a> of file <a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae6ed6a653c43698a1480c0230b1e99aa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae6ed6a653c43698a1480c0230b1e99aa">◆ </a></span>LedgerHash</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1RelationalDatabase.html#ae6ed6a653c43698a1480c0230b1e99aa">ripple::RelationalDatabase::LedgerHash</a> = <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8h_source.html#l00091">91</a> of file <a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a99c471461c2b0858d240f98034c6fda3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a99c471461c2b0858d240f98034c6fda3">◆ </a></span>LedgerShortcut</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="namespaceripple_1_1RPC.html#a4c04e509451d50d9449cff3d477ff4f2">ripple::RelationalDatabase::LedgerShortcut</a> = <a class="el" href="namespaceripple_1_1RPC.html#a4c04e509451d50d9449cff3d477ff4f2">RPC::LedgerShortcut</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8h_source.html#l00092">92</a> of file <a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae6edb30f534bd5669ee659789aa22e86"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae6edb30f534bd5669ee659789aa22e86">◆ </a></span>LedgerSpecifier</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1RelationalDatabase.html#ae6edb30f534bd5669ee659789aa22e86">ripple::RelationalDatabase::LedgerSpecifier</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/variant.html">std::variant</a><<a class="el" href="structripple_1_1LedgerRange.html">LedgerRange</a>, <a class="el" href="namespaceripple_1_1RPC.html#a4c04e509451d50d9449cff3d477ff4f2">LedgerShortcut</a>, <a class="el" href="classripple_1_1RelationalDatabase.html#affdfbc3c5f0f2d7b78cc5570617a5fda">LedgerSequence</a>, <a class="el" href="classripple_1_1RelationalDatabase.html#ae6ed6a653c43698a1480c0230b1e99aa">LedgerHash</a>></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8h_source.html#l00094">94</a> of file <a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a777dd8559a055cca317f9525694be1c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a777dd8559a055cca317f9525694be1c4">◆ </a></span>stop()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void ripple::PostgresDatabase::stop </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a790b0907cabeaa9309e53df35caf2270">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad14da01d1b10dbcc73c16b729ed67b1a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad14da01d1b10dbcc73c16b729ed67b1a">◆ </a></span>sweep()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void ripple::PostgresDatabase::sweep </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>sweep Sweeps the database. </p>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a3a18dfaba02fe5f4535e0f7eeff62568">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a638a2672a99fd56dc7c534a65de82422"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a638a2672a99fd56dc7c534a65de82422">◆ </a></span>getCompleteLedgers()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> ripple::PostgresDatabase::getCompleteLedgers </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getCompleteLedgers Returns a string which contains a list of completed ledgers. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>String with completed ledger sequences </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a10f42a66974feddf42ab5b70cc6f2da8">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acbad8709817f45cb6879fd6bbb8168d9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acbad8709817f45cb6879fd6bbb8168d9">◆ </a></span>getValidatedLedgerAge()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a> ripple::PostgresDatabase::getValidatedLedgerAge </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getValidatedLedgerAge Returns the age of the last validated ledger. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Age of the last validated ledger in seconds </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a93c76cb1c9bdbe3b7bb3ea9297332fba">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a80ccf4e291a450fb7dda321479677e32"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a80ccf4e291a450fb7dda321479677e32">◆ </a></span>writeLedgerAndTransactions()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ripple::PostgresDatabase::writeLedgerAndTransactions </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1LedgerInfo.html">LedgerInfo</a> const & </td>
|
|
<td class="paramname"><em>info</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>< <a class="el" href="structripple_1_1RelationalDatabase_1_1AccountTransactionsData.html">AccountTransactionsData</a> > const & </td>
|
|
<td class="paramname"><em>accountTxData</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>writeLedgerAndTransactions Writes new ledger and transaction data into the database. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">info</td><td><a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> info to write. </td></tr>
|
|
<tr><td class="paramname">accountTxData</td><td><a class="el" href="classripple_1_1Transaction.html">Transaction</a> data to write </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True on success, false on failure. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a1b093ff1efa295270aaa0b34381ba455">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a784583e95d607018791e7073784bd04d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a784583e95d607018791e7073784bd04d">◆ </a></span>getTxHashes()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a><<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a>> ripple::PostgresDatabase::getTxHashes </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> </td>
|
|
<td class="paramname"><em>seq</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getTxHashes Returns a vector of the hashes of transactions belonging to the ledger with the provided sequence. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">seq</td><td><a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> sequence </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Vector of transaction hashes </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a9137b0128b53180e5e2888e45a17027e">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af006b47c3c1caa59cc062700a4d41741"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af006b47c3c1caa59cc062700a4d41741">◆ </a></span>getAccountTx()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a><<a class="el" href="structripple_1_1RelationalDatabase_1_1AccountTxResult.html">AccountTxResult</a>, <a class="el" href="structripple_1_1RPC_1_1Status.html">RPC::Status</a>> ripple::PostgresDatabase::getAccountTx </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1RelationalDatabase_1_1AccountTxArgs.html">AccountTxArgs</a> const & </td>
|
|
<td class="paramname"><em>args</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getAccountTx Get the last account transactions specified by the AccountTxArgs struct. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">args</td><td>Arguments which specify the account and which transactions to return. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Vector of account transactions and the <a class="el" href="namespaceripple_1_1RPC.html">RPC</a> status response. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a2ec203479d0d36415fc638adeb6cc115">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7ba9f944c4586b5b93018d828ace12b8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7ba9f944c4586b5b93018d828ace12b8">◆ </a></span>locateTransaction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="structripple_1_1Transaction_1_1Locator.html">Transaction::Locator</a> ripple::PostgresDatabase::locateTransaction </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const & </td>
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>locateTransaction Returns information used to locate a transaction. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Hash of the transaction. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Information used to locate a transaction. Contains a nodestore hash and a ledger sequence pair if the transaction was found. Otherwise, contains the range of ledgers present in the database at the time of search. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a63de1d50319ee10af6bad0dd2ac51fab">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeff0aabad25764e5b7bd22acfd9c3a82"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeff0aabad25764e5b7bd22acfd9c3a82">◆ </a></span>isCaughtUp()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ripple::PostgresDatabase::isCaughtUp </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> & </td>
|
|
<td class="paramname"><em>reason</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>isCaughtUp returns whether the database is caught up with the network </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">reason</td><td>if the database is not caught up, reason contains a helpful message describing why </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>false if the most recently written ledger has a close time over 3 minutes ago, or if there are no ledgers in the database. true otherwise </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a317f4a4105f83ff73370b7075e618fd0">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7f08e20557d394e761662ff29373f467"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7f08e20557d394e761662ff29373f467">◆ </a></span>init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< <a class="el" href="classripple_1_1RelationalDatabase.html">RelationalDatabase</a> > ripple::RelationalDatabase::init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Application.html">Application</a> & </td>
|
|
<td class="paramname"><em>app</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Config.html">Config</a> const & </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1JobQueue.html">JobQueue</a> & </td>
|
|
<td class="paramname"><em>jobQueue</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>init Creates and returns an appropriate <a class="el" href="classripple_1_1RelationalDatabase.html">RelationalDatabase</a> instance based on configuration. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">app</td><td><a class="el" href="classripple_1_1Application.html">Application</a> object. </td></tr>
|
|
<tr><td class="paramname">config</td><td><a class="el" href="classripple_1_1Config.html">Config</a> object. </td></tr>
|
|
<tr><td class="paramname">jobQueue</td><td><a class="el" href="classripple_1_1JobQueue.html" title="A pool of threads to perform work.">JobQueue</a> object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Unique pointer to the interface. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8cpp_source.html#l00034">34</a> of file <a class="el" href="RelationalDatabase_8cpp_source.html">RelationalDatabase.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0075f77f85eb16d36fdd35974acfb8ea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0075f77f85eb16d36fdd35974acfb8ea">◆ </a></span>getMinLedgerSeq()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a><<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a>> ripple::RelationalDatabase::getMinLedgerSeq </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getMinLedgerSeq Returns the minimum ledger sequence in the Ledgers table. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> sequence or no value if no ledgers exist. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a3aff3775078aaa487ce9ef7118f9d83e">ripple::PostgresDatabaseImp</a>, and <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a8730d0f70b92408cf5be5e83715ffb07">ripple::SQLiteDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa4e757a2656cd3c537e997e8a67ee78a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa4e757a2656cd3c537e997e8a67ee78a">◆ </a></span>getMaxLedgerSeq()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a><<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a>> ripple::RelationalDatabase::getMaxLedgerSeq </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getMaxLedgerSeq Returns the maximum ledger sequence in the Ledgers table. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> sequence or none if no ledgers exist. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1PostgresDatabaseImp.html#ae0497da471d261f1647531eee85b18a9">ripple::PostgresDatabaseImp</a>, and <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a2654ba0e88a9e8aaa0e6686d90edf4ca">ripple::SQLiteDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4b67ba7e09ea642386597210efefe07d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4b67ba7e09ea642386597210efefe07d">◆ </a></span>getLedgerInfoByIndex()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a><<a class="el" href="structripple_1_1LedgerInfo.html">LedgerInfo</a>> ripple::RelationalDatabase::getLedgerInfoByIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> </td>
|
|
<td class="paramname"><em>ledgerSeq</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getLedgerInfoByIndex Returns a ledger by its sequence. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledgerSeq</td><td><a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> sequence. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The ledger if found, otherwise no value. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#af98c9aa88ce231f95164cec02e58ed0d">ripple::SQLiteDatabaseImp</a>, and <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a4a2470e10bd922ac8ca13d4818510060">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acbc9c19a6c01c6004df183ed8858f88b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acbc9c19a6c01c6004df183ed8858f88b">◆ </a></span>getNewestLedgerInfo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a><<a class="el" href="structripple_1_1LedgerInfo.html">LedgerInfo</a>> ripple::RelationalDatabase::getNewestLedgerInfo </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getNewestLedgerInfo Returns the info of the newest saved ledger. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> info if found, otherwise no value. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a1416bd1f665f27453f8dce95f0818fbb">ripple::SQLiteDatabaseImp</a>, and <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a64195350ec9e7043d4963346766d26a9">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2df06f73b03baa40ff0cc92066d9fd3b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2df06f73b03baa40ff0cc92066d9fd3b">◆ </a></span>getLedgerInfoByHash()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a><<a class="el" href="structripple_1_1LedgerInfo.html">LedgerInfo</a>> ripple::RelationalDatabase::getLedgerInfoByHash </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const & </td>
|
|
<td class="paramname"><em>ledgerHash</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getLedgerInfoByHash Returns the info of the ledger with given hash. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledgerHash</td><td>Hash of the ledger. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> if found, otherwise no value. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a575ad184e70064a3e324ea435fa58333">ripple::SQLiteDatabaseImp</a>, and <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a15e0d6d6c71c77cc64cdb50e17154451">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae73b0356cc96e29c9c66e52f64aeac0d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae73b0356cc96e29c9c66e52f64aeac0d">◆ </a></span>getHashByIndex()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> ripple::RelationalDatabase::getHashByIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> </td>
|
|
<td class="paramname"><em>ledgerIndex</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getHashByIndex Returns the hash of the ledger with the given sequence. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledgerIndex</td><td><a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> sequence. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Hash of the ledger. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#ad7796a6d5a4a4b0a7fd7feb7e23f612b">ripple::SQLiteDatabaseImp</a>, and <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a060af4b68fab45d700f44565713dcb9f">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a177aaf55106410ac5a2b2969674d4d57"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a177aaf55106410ac5a2b2969674d4d57">◆ </a></span>getHashesByIndex() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a><<a class="el" href="structripple_1_1LedgerHashPair.html">LedgerHashPair</a>> ripple::RelationalDatabase::getHashesByIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> </td>
|
|
<td class="paramname"><em>ledgerIndex</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getHashesByIndex Returns the hashes of the ledger and its parent as specified by the ledgerIndex. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledgerIndex</td><td><a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> sequence. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Struct <a class="el" href="structripple_1_1LedgerHashPair.html">LedgerHashPair</a> which contains hashes of the ledger and its parent. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a8e0a657a3892d93fdf957d892f1729c2">ripple::SQLiteDatabaseImp</a>, and <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a21f82c0714c06dac9b05f4bc00b8ad08">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4d01c850566c044f3d595db5b16cc7c0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d01c850566c044f3d595db5b16cc7c0">◆ </a></span>getHashesByIndex() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/container/map.html">std::map</a><<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a>, <a class="el" href="structripple_1_1LedgerHashPair.html">LedgerHashPair</a>> ripple::RelationalDatabase::getHashesByIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> </td>
|
|
<td class="paramname"><em>minSeq</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> </td>
|
|
<td class="paramname"><em>maxSeq</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getHashesByIndex Returns hashes of each ledger and its parent for all ledgers within the provided range. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">minSeq</td><td>Minimum ledger sequence. </td></tr>
|
|
<tr><td class="paramname">maxSeq</td><td>Maximum ledger sequence. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Container that maps the sequence number of a found ledger to the struct <a class="el" href="structripple_1_1LedgerHashPair.html">LedgerHashPair</a> which contains the hashes of the ledger and its parent. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a5eb08bfeccc246735821bbd45a82c4b2">ripple::SQLiteDatabaseImp</a>, and <a class="el" href="classripple_1_1PostgresDatabaseImp.html#ad32e02bffab00459a5e6b67486960c5c">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae6c8de0e4ae5d6b0ad97d0ac219196d5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae6c8de0e4ae5d6b0ad97d0ac219196d5">◆ </a></span>getTxHistory()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a><<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a><<a class="el" href="classripple_1_1Transaction.html">Transaction</a>> > ripple::RelationalDatabase::getTxHistory </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> </td>
|
|
<td class="paramname"><em>startIndex</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getTxHistory Returns the 20 most recent transactions starting from the given number. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">startIndex</td><td>First number of returned entry. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Vector of shared pointers to transactions sorted in descending order by ledger sequence. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a95e09f3d9aad4bddd230a858ebc523f0">ripple::SQLiteDatabaseImp</a>, and <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a0084018c94d6d1f922e679c80e45de6f">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7d4e0e3c03536c80901f72355139a483"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7d4e0e3c03536c80901f72355139a483">◆ </a></span>ledgerDbHasSpace()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ripple::RelationalDatabase::ledgerDbHasSpace </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Config.html">Config</a> const & </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>ledgerDbHasSpace Checks if the ledger database has available space. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td><a class="el" href="classripple_1_1Config.html">Config</a> object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if space is available. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a311a803593ac3b5ce62b3263f4d298bd">ripple::SQLiteDatabaseImp</a>, and <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a7350424c6e5750abc473b6855d21fabb">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a59c527306560ba3cf9d774fc73ee29a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a59c527306560ba3cf9d774fc73ee29a4">◆ </a></span>transactionDbHasSpace()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ripple::RelationalDatabase::transactionDbHasSpace </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Config.html">Config</a> const & </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>transactionDbHasSpace Checks if the transaction database has available space. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td><a class="el" href="classripple_1_1Config.html">Config</a> object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if space is available. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a004a13d01781eb4ffd043a0934c99b39">ripple::SQLiteDatabaseImp</a>, and <a class="el" href="classripple_1_1PostgresDatabaseImp.html#a34c266907f8549408ffe730ccc0dd5c2">ripple::PostgresDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|