| <!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.15"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Apache Geode Native C++ Reference: apache::geode::client::QueryService 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="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</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">Apache Geode Native C++ Reference |
|  <span id="projectnumber">1.13.0</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <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> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('a00811.html','');}); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- 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 class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">apache::geode::client::QueryService Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="a00811.html" title="QueryService is the class obtained from a Cache.">QueryService</a> is the class obtained from a <a class="el" href="a00287.html" title="Caches are obtained from the create method on the CacheFactory#create class.">Cache</a>. |
| <a href="a00811.html#details">More...</a></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:ab03a9f051d462060c4299624975e03ca"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#ab03a9f051d462060c4299624975e03ca">closeCqs</a> ()=0</td></tr> |
| <tr class="memdesc:ab03a9f051d462060c4299624975e03ca"><td class="mdescLeft"> </td><td class="mdescRight">Close all CQs, and release resources associated with executing CQs. <a href="#ab03a9f051d462060c4299624975e03ca">More...</a><br /></td></tr> |
| <tr class="separator:ab03a9f051d462060c4299624975e03ca"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4b676cdbdce07fca000789df6e5ea724"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#a4b676cdbdce07fca000789df6e5ea724">executeCqs</a> ()=0</td></tr> |
| <tr class="memdesc:a4b676cdbdce07fca000789df6e5ea724"><td class="mdescLeft"> </td><td class="mdescRight">@nativeclient Executes all the cqs on this client. <a href="#a4b676cdbdce07fca000789df6e5ea724">More...</a><br /></td></tr> |
| <tr class="separator:a4b676cdbdce07fca000789df6e5ea724"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3d882aaad5517a88b7568d6d5708d7d5"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="a00303.html">CacheableArrayList</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#a3d882aaad5517a88b7568d6d5708d7d5">getAllDurableCqsFromServer</a> () const =0</td></tr> |
| <tr class="memdesc:a3d882aaad5517a88b7568d6d5708d7d5"><td class="mdescLeft"> </td><td class="mdescRight">Gets all the durable CQs registered by this client. <a href="#a3d882aaad5517a88b7568d6d5708d7d5">More...</a><br /></td></tr> |
| <tr class="separator:a3d882aaad5517a88b7568d6d5708d7d5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad754c5568f06499f7ce52fa25373bef1"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="a00415.html">CqQuery</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#ad754c5568f06499f7ce52fa25373bef1">getCq</a> (const std::string &name) const =0</td></tr> |
| <tr class="memdesc:ad754c5568f06499f7ce52fa25373bef1"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a <a class="el" href="a00415.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">CqQuery</a> by name. <a href="#ad754c5568f06499f7ce52fa25373bef1">More...</a><br /></td></tr> |
| <tr class="separator:ad754c5568f06499f7ce52fa25373bef1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa809b95267fe2346ca05da62ab10d3d4"><td class="memItemLeft" align="right" valign="top">virtual query_container_type </td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#aa809b95267fe2346ca05da62ab10d3d4">getCqs</a> () const =0</td></tr> |
| <tr class="memdesc:aa809b95267fe2346ca05da62ab10d3d4"><td class="mdescLeft"> </td><td class="mdescRight">@nativeclient Retrieve all registered CQs @endnativeclient <a href="#aa809b95267fe2346ca05da62ab10d3d4">More...</a><br /></td></tr> |
| <tr class="separator:aa809b95267fe2346ca05da62ab10d3d4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9750b7d30a2d73ddc53d8a23d72a0cc6"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="a00423.html">CqServiceStatistics</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#a9750b7d30a2d73ddc53d8a23d72a0cc6">getCqServiceStatistics</a> () const =0</td></tr> |
| <tr class="memdesc:a9750b7d30a2d73ddc53d8a23d72a0cc6"><td class="mdescLeft"> </td><td class="mdescRight">@nativeclient Get statistics information for all CQs <a href="#a9750b7d30a2d73ddc53d8a23d72a0cc6">More...</a><br /></td></tr> |
| <tr class="separator:a9750b7d30a2d73ddc53d8a23d72a0cc6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad2715272fc10d26223d2dee60f2d78d4"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="a00415.html">CqQuery</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#ad2715272fc10d26223d2dee60f2d78d4">newCq</a> (std::string name, std::string querystr, const std::shared_ptr< <a class="el" href="a00395.html">CqAttributes</a> > &cqAttr, bool isDurable=false)=0</td></tr> |
| <tr class="memdesc:ad2715272fc10d26223d2dee60f2d78d4"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new named continuous query, represented by an instance of <a class="el" href="a00415.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">CqQuery</a>. <a href="#ad2715272fc10d26223d2dee60f2d78d4">More...</a><br /></td></tr> |
| <tr class="separator:ad2715272fc10d26223d2dee60f2d78d4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acd2763e85abcd5035fc534af9f0b0d0a"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="a00415.html">CqQuery</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#acd2763e85abcd5035fc534af9f0b0d0a">newCq</a> (std::string querystr, const std::shared_ptr< <a class="el" href="a00395.html">CqAttributes</a> > &cqAttr, bool isDurable=false)=0</td></tr> |
| <tr class="memdesc:acd2763e85abcd5035fc534af9f0b0d0a"><td class="mdescLeft"> </td><td class="mdescRight">@nativeclient Constructs a new named continuous query, represented by an instance of <a class="el" href="a00415.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">CqQuery</a>. <a href="#acd2763e85abcd5035fc534af9f0b0d0a">More...</a><br /></td></tr> |
| <tr class="separator:acd2763e85abcd5035fc534af9f0b0d0a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab4039c6723b533a165d1af714314c32e"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="a00807.html">Query</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#ab4039c6723b533a165d1af714314c32e">newQuery</a> (std::string querystr)=0</td></tr> |
| <tr class="memdesc:ab4039c6723b533a165d1af714314c32e"><td class="mdescLeft"> </td><td class="mdescRight">Get a new <a class="el" href="a00807.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">Query</a> with the specified query string. <a href="#ab4039c6723b533a165d1af714314c32e">More...</a><br /></td></tr> |
| <tr class="separator:ab4039c6723b533a165d1af714314c32e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab07dc8ad779710ab9713b06bf7aee1fa"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00811.html#ab07dc8ad779710ab9713b06bf7aee1fa">stopCqs</a> ()=0</td></tr> |
| <tr class="memdesc:ab07dc8ad779710ab9713b06bf7aee1fa"><td class="mdescLeft"> </td><td class="mdescRight">Stops all the cqs on this client. <a href="#ab07dc8ad779710ab9713b06bf7aee1fa">More...</a><br /></td></tr> |
| <tr class="separator:ab07dc8ad779710ab9713b06bf7aee1fa"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="a00811.html" title="QueryService is the class obtained from a Cache.">QueryService</a> is the class obtained from a <a class="el" href="a00287.html" title="Caches are obtained from the create method on the CacheFactory#create class.">Cache</a>. </p> |
| <p>A <a class="el" href="a00807.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">Query</a> is created from a <a class="el" href="a00811.html" title="QueryService is the class obtained from a Cache.">QueryService</a> and executed on the server returning a <a class="el" href="a00851.html" title="A SelectResults is obtained by executing a Query on the server.">SelectResults</a> which can be either a <a class="el" href="a00847.html" title="A ResultSet may be obtained after executing a Query which is obtained from a QueryService which in tu...">ResultSet</a> or a <a class="el" href="a00863.html" title="A StructSet may be obtained after executing a Query which is obtained from a QueryService which in tu...">StructSet</a>. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ab03a9f051d462060c4299624975e03ca"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab03a9f051d462060c4299624975e03ca">◆ </a></span>closeCqs()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void apache::geode::client::QueryService::closeCqs </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>Close all CQs, and release resources associated with executing CQs. </p> |
| |
| </div> |
| </div> |
| <a id="a4b676cdbdce07fca000789df6e5ea724"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4b676cdbdce07fca000789df6e5ea724">◆ </a></span>executeCqs()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void apache::geode::client::QueryService::executeCqs </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>@nativeclient Executes all the cqs on this client. </p> |
| <p>@endnativeclient </p> |
| |
| </div> |
| </div> |
| <a id="a3d882aaad5517a88b7568d6d5708d7d5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3d882aaad5517a88b7568d6d5708d7d5">◆ </a></span>getAllDurableCqsFromServer()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual std::shared_ptr<<a class="el" href="a00303.html">CacheableArrayList</a>> apache::geode::client::QueryService::getAllDurableCqsFromServer </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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets all the durable CQs registered by this client. </p> |
| <dl class="section return"><dt>Returns</dt><dd>List of names of registered durable CQs, empty list if no durable cqs. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ad754c5568f06499f7ce52fa25373bef1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad754c5568f06499f7ce52fa25373bef1">◆ </a></span>getCq()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual std::shared_ptr<<a class="el" href="a00415.html">CqQuery</a>> apache::geode::client::QueryService::getCq </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td> const</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>Retrieve a <a class="el" href="a00415.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">CqQuery</a> by name. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the <a class="el" href="a00415.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">CqQuery</a> or nullptr if not found </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa809b95267fe2346ca05da62ab10d3d4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa809b95267fe2346ca05da62ab10d3d4">◆ </a></span>getCqs()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual query_container_type apache::geode::client::QueryService::getCqs </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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>@nativeclient Retrieve all registered CQs @endnativeclient </p> |
| |
| </div> |
| </div> |
| <a id="a9750b7d30a2d73ddc53d8a23d72a0cc6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9750b7d30a2d73ddc53d8a23d72a0cc6">◆ </a></span>getCqServiceStatistics()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual std::shared_ptr<<a class="el" href="a00423.html">CqServiceStatistics</a>> apache::geode::client::QueryService::getCqServiceStatistics </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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>@nativeclient Get statistics information for all CQs </p> |
| <dl class="section return"><dt>Returns</dt><dd>the <a class="el" href="a00423.html" title="This class provides methods to get aggregate statistical information about the CQs of a client.">CqServiceStatistics</a> @endnativeclient </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ad2715272fc10d26223d2dee60f2d78d4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad2715272fc10d26223d2dee60f2d78d4">◆ </a></span>newCq() <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 std::shared_ptr<<a class="el" href="a00415.html">CqQuery</a>> apache::geode::client::QueryService::newCq </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>querystr</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="a00395.html">CqAttributes</a> > & </td> |
| <td class="paramname"><em>cqAttr</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>isDurable</em> = <code>false</code> </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>Constructs a new named continuous query, represented by an instance of <a class="el" href="a00415.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">CqQuery</a>. </p> |
| <p>The <a class="el" href="a00415.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">CqQuery</a> is not executed, however, until the execute method is invoked on the <a class="el" href="a00415.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">CqQuery</a>. The name of the query will be used to identify this query in statistics archival.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">cqName</td><td>the String name for this query </td></tr> |
| <tr><td class="paramname">queryString</td><td>the OQL query </td></tr> |
| <tr><td class="paramname">cqAttributes</td><td>the <a class="el" href="a00395.html" title="This interface holds all attribute values for a CQ and provides methods for retrieving all attribute ...">CqAttributes</a> </td></tr> |
| <tr><td class="paramname">isDurable</td><td>true if the CQ is durable </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the newly created <a class="el" href="a00415.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">CqQuery</a> object </dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00671.html" title="Thrown if a Cq by this name already exists on this client.">CqExistsException</a></td><td>if a CQ by this name already exists on this client </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00471.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>if queryString is null, or cqAttr is nullptr </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00475.html" title="Thrown when the state of cache is manipulated to be illegal.">IllegalStateException</a></td><td>if this method is called from a cache server </td></tr> |
| <tr><td class="paramname">QueryInvalidException</td><td>if there is a syntax error in the query </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00659.html" title="Thrown during continuous query execution time.">CqException</a></td><td>if failed to create cq, failure during creating managing cq metadata info. </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00675.html" title="Thrown if the query doesnot meet the CQ constraints.">CqInvalidException</a></td><td>if the query doesnot meet the CQ constraints. E.g.: <a class="el" href="a00807.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">Query</a> string should refer only one region, join not supported. The query must be a SELECT statement. DISTINCT queries are not supported. Projections are not supported. Only one iterator in the FROM clause is supported, and it must be a region path. Bind parameters in the query are not supported for the initial release. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="acd2763e85abcd5035fc534af9f0b0d0a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acd2763e85abcd5035fc534af9f0b0d0a">◆ </a></span>newCq() <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 std::shared_ptr<<a class="el" href="a00415.html">CqQuery</a>> apache::geode::client::QueryService::newCq </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>querystr</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="a00395.html">CqAttributes</a> > & </td> |
| <td class="paramname"><em>cqAttr</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>isDurable</em> = <code>false</code> </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>@nativeclient Constructs a new named continuous query, represented by an instance of <a class="el" href="a00415.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">CqQuery</a>. </p> |
| <p>The <a class="el" href="a00415.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">CqQuery</a> is not executed, however, until the execute method is invoked on the <a class="el" href="a00415.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">CqQuery</a>. The name of the query will be used to identify this query in statistics archival.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">queryString</td><td>the OQL query </td></tr> |
| <tr><td class="paramname">cqAttributes</td><td>the <a class="el" href="a00395.html" title="This interface holds all attribute values for a CQ and provides methods for retrieving all attribute ...">CqAttributes</a> </td></tr> |
| <tr><td class="paramname">isDurable</td><td>true if the CQ is durable </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the newly created <a class="el" href="a00415.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">CqQuery</a> object </dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00671.html" title="Thrown if a Cq by this name already exists on this client.">CqExistsException</a></td><td>if a CQ by this name already exists on this client </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00471.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>if queryString is null, or cqAttr is nullptr </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00475.html" title="Thrown when the state of cache is manipulated to be illegal.">IllegalStateException</a></td><td>if this method is called from a cache server </td></tr> |
| <tr><td class="paramname">QueryInvalidException</td><td>if there is a syntax error in the query </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00659.html" title="Thrown during continuous query execution time.">CqException</a></td><td>if failed to create cq, failure during creating managing cq metadata info. </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00675.html" title="Thrown if the query doesnot meet the CQ constraints.">CqInvalidException</a></td><td>if the query doesnot meet the CQ constraints. E.g.: <a class="el" href="a00807.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">Query</a> string should refer only one region, join not supported. The query must be a SELECT statement. DISTINCT queries are not supported. Projections are not supported. Only one iterator in the FROM clause is supported, and it must be a region path. Bind parameters in the query are not supported for the initial release.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>@endnativeclient </p> |
| |
| </div> |
| </div> |
| <a id="ab4039c6723b533a165d1af714314c32e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab4039c6723b533a165d1af714314c32e">◆ </a></span>newQuery()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual std::shared_ptr<<a class="el" href="a00807.html">Query</a>> apache::geode::client::QueryService::newQuery </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>querystr</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>Get a new <a class="el" href="a00807.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">Query</a> with the specified query string. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">querystr</td><td>The query string with which to create a new <a class="el" href="a00807.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">Query</a>. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A smart pointer to the <a class="el" href="a00807.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">Query</a>. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ab07dc8ad779710ab9713b06bf7aee1fa"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab07dc8ad779710ab9713b06bf7aee1fa">◆ </a></span>stopCqs()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void apache::geode::client::QueryService::stopCqs </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>Stops all the cqs on this client. </p> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <HR><address style="align: right;"><small>Apache Geode C++ Cache API Documentation</small></address> |
