| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title> Apache Ignite C++: ignite::cache::query::ScanQuery 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="projectlogo"><img alt="Logo" src="ignite_logo.png"/></td> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname"> Apache Ignite C++ |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </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="namespaceignite.html">ignite</a></li><li class="navelem"><a class="el" href="namespaceignite_1_1cache.html">cache</a></li><li class="navelem"><a class="el" href="namespaceignite_1_1cache_1_1query.html">query</a></li><li class="navelem"><a class="el" href="classignite_1_1cache_1_1query_1_1ScanQuery.html">ScanQuery</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classignite_1_1cache_1_1query_1_1ScanQuery-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">ignite::cache::query::ScanQuery Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Scan query. |
| <a href="classignite_1_1cache_1_1query_1_1ScanQuery.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="query__scan_8h_source.html">query_scan.h</a>></code></p> |
| <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:a5a55d6bee94c6493eaa28a80998bdeda"><td class="memItemLeft" align="right" valign="top"><a id="a5a55d6bee94c6493eaa28a80998bdeda"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1ScanQuery.html#a5a55d6bee94c6493eaa28a80998bdeda">ScanQuery</a> ()</td></tr> |
| <tr class="memdesc:a5a55d6bee94c6493eaa28a80998bdeda"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr> |
| <tr class="separator:a5a55d6bee94c6493eaa28a80998bdeda"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9ecccb5eb3666d47e9e303634409fc9d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1ScanQuery.html#a9ecccb5eb3666d47e9e303634409fc9d">ScanQuery</a> (int32_t part)</td></tr> |
| <tr class="memdesc:a9ecccb5eb3666d47e9e303634409fc9d"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a9ecccb5eb3666d47e9e303634409fc9d">More...</a><br /></td></tr> |
| <tr class="separator:a9ecccb5eb3666d47e9e303634409fc9d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaa72e87cfa57496f11144d0a69397d36"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1ScanQuery.html#aaa72e87cfa57496f11144d0a69397d36">GetPartition</a> () const</td></tr> |
| <tr class="memdesc:aaa72e87cfa57496f11144d0a69397d36"><td class="mdescLeft"> </td><td class="mdescRight">Get partition to scan. <a href="#aaa72e87cfa57496f11144d0a69397d36">More...</a><br /></td></tr> |
| <tr class="separator:aaa72e87cfa57496f11144d0a69397d36"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a55fb7a45eb8520fd949c0f749dfa53ba"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1ScanQuery.html#a55fb7a45eb8520fd949c0f749dfa53ba">SetPartition</a> (int32_t part)</td></tr> |
| <tr class="memdesc:a55fb7a45eb8520fd949c0f749dfa53ba"><td class="mdescLeft"> </td><td class="mdescRight">Set partition to scan. <a href="#a55fb7a45eb8520fd949c0f749dfa53ba">More...</a><br /></td></tr> |
| <tr class="separator:a55fb7a45eb8520fd949c0f749dfa53ba"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a06c2b2f939d52e21f2e2dfa67b041adf"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1ScanQuery.html#a06c2b2f939d52e21f2e2dfa67b041adf">GetPageSize</a> () const</td></tr> |
| <tr class="memdesc:a06c2b2f939d52e21f2e2dfa67b041adf"><td class="mdescLeft"> </td><td class="mdescRight">Get page size. <a href="#a06c2b2f939d52e21f2e2dfa67b041adf">More...</a><br /></td></tr> |
| <tr class="separator:a06c2b2f939d52e21f2e2dfa67b041adf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad459033dcf311b1b25e46fb1dbb2b55e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1ScanQuery.html#ad459033dcf311b1b25e46fb1dbb2b55e">SetPageSize</a> (int32_t pageSize)</td></tr> |
| <tr class="memdesc:ad459033dcf311b1b25e46fb1dbb2b55e"><td class="mdescLeft"> </td><td class="mdescRight">Set page size. <a href="#ad459033dcf311b1b25e46fb1dbb2b55e">More...</a><br /></td></tr> |
| <tr class="separator:ad459033dcf311b1b25e46fb1dbb2b55e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a66bc6ad3e2329ce592de9a210026dfa6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1ScanQuery.html#a66bc6ad3e2329ce592de9a210026dfa6">IsLocal</a> () const</td></tr> |
| <tr class="memdesc:a66bc6ad3e2329ce592de9a210026dfa6"><td class="mdescLeft"> </td><td class="mdescRight">Get local flag. <a href="#a66bc6ad3e2329ce592de9a210026dfa6">More...</a><br /></td></tr> |
| <tr class="separator:a66bc6ad3e2329ce592de9a210026dfa6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a353a5b9cedbe16411aa0341328126856"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1ScanQuery.html#a353a5b9cedbe16411aa0341328126856">SetLocal</a> (bool loc)</td></tr> |
| <tr class="memdesc:a353a5b9cedbe16411aa0341328126856"><td class="mdescLeft"> </td><td class="mdescRight">Set local flag. <a href="#a353a5b9cedbe16411aa0341328126856">More...</a><br /></td></tr> |
| <tr class="separator:a353a5b9cedbe16411aa0341328126856"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2f699cd0a53379ad01bf98aa9f958625"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1ScanQuery.html#a2f699cd0a53379ad01bf98aa9f958625">Write</a> (<a class="el" href="classignite_1_1binary_1_1BinaryRawWriter.html">binary::BinaryRawWriter</a> &writer) const</td></tr> |
| <tr class="memdesc:a2f699cd0a53379ad01bf98aa9f958625"><td class="mdescLeft"> </td><td class="mdescRight">Write query info to the stream. <a href="#a2f699cd0a53379ad01bf98aa9f958625">More...</a><br /></td></tr> |
| <tr class="separator:a2f699cd0a53379ad01bf98aa9f958625"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Scan query. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a9ecccb5eb3666d47e9e303634409fc9d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9ecccb5eb3666d47e9e303634409fc9d">◆ </a></span>ScanQuery()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">ignite::cache::query::ScanQuery::ScanQuery </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>part</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">part</td><td>Partition. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a06c2b2f939d52e21f2e2dfa67b041adf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a06c2b2f939d52e21f2e2dfa67b041adf">◆ </a></span>GetPageSize()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int32_t ignite::cache::query::ScanQuery::GetPageSize </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get page size. </p> |
| <dl class="section return"><dt>Returns</dt><dd>Page size. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aaa72e87cfa57496f11144d0a69397d36"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaa72e87cfa57496f11144d0a69397d36">◆ </a></span>GetPartition()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int32_t ignite::cache::query::ScanQuery::GetPartition </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get partition to scan. </p> |
| <dl class="section return"><dt>Returns</dt><dd>Partition to scan. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a66bc6ad3e2329ce592de9a210026dfa6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a66bc6ad3e2329ce592de9a210026dfa6">◆ </a></span>IsLocal()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool ignite::cache::query::ScanQuery::IsLocal </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get local flag. </p> |
| <dl class="section return"><dt>Returns</dt><dd>Local flag. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a353a5b9cedbe16411aa0341328126856"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a353a5b9cedbe16411aa0341328126856">◆ </a></span>SetLocal()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void ignite::cache::query::ScanQuery::SetLocal </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>loc</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set local flag. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">loc</td><td>Local flag. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ad459033dcf311b1b25e46fb1dbb2b55e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad459033dcf311b1b25e46fb1dbb2b55e">◆ </a></span>SetPageSize()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void ignite::cache::query::ScanQuery::SetPageSize </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>pageSize</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set page size. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">pageSize</td><td>Page size. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a55fb7a45eb8520fd949c0f749dfa53ba"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a55fb7a45eb8520fd949c0f749dfa53ba">◆ </a></span>SetPartition()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void ignite::cache::query::ScanQuery::SetPartition </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>part</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set partition to scan. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">part</td><td>Partition to scan. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a2f699cd0a53379ad01bf98aa9f958625"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2f699cd0a53379ad01bf98aa9f958625">◆ </a></span>Write()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void ignite::cache::query::ScanQuery::Write </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classignite_1_1binary_1_1BinaryRawWriter.html">binary::BinaryRawWriter</a> & </td> |
| <td class="paramname"><em>writer</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Write query info to the stream. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">writer</td><td>Writer. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="query__scan_8h_source.html">query_scan.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Mon Dec 20 2021 14:08:59 for Apache Ignite C++ by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
