Google Git
Sign in
apache / ignite-website / 372257fe483ecaf031bfad76800308d2eed57097 / . / releases / 2.1.0 / dotnetdoc / class_apache_1_1_ignite_1_1_linq_1_1_query_options.html
blob: 2110c5f1e396d9b5d34dd28e1b4949d0336d1abf [file] [log] [blame]
<!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>
<link rel="canonical" href="https://ignite.apache.org/releases/2.1.0/dotnetdoc/class_apache_1_1_ignite_1_1_linq_1_1_query_options.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<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.11"/>
<title>Apache Ignite.NET: Apache.Ignite.Linq.QueryOptions 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">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61232409-1', 'auto');
ga('send', 'pageview');
</script></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.NET
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
</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">
$(document).ready(function(){initNavTree('class_apache_1_1_ignite_1_1_linq_1_1_query_options.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_apache_1_1_ignite_1_1_linq_1_1_query_options-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Ignite.Linq.QueryOptions Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Cache query options.
<a href="class_apache_1_1_ignite_1_1_linq_1_1_query_options.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:acd75dba01e9582d10d6aead79b5b4f4d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_query_options.html#acd75dba01e9582d10d6aead79b5b4f4d">QueryOptions</a> ()</td></tr>
<tr class="memdesc:acd75dba01e9582d10d6aead79b5b4f4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a new instance of the <a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_query_options.html" title="Cache query options. ">QueryOptions</a> class. <a href="#acd75dba01e9582d10d6aead79b5b4f4d">More...</a><br /></td></tr>
<tr class="separator:acd75dba01e9582d10d6aead79b5b4f4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aec977d5e2434be57c192143dd65870e9"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_query_options.html#aec977d5e2434be57c192143dd65870e9">DefaultPageSize</a> = SqlFieldsQuery.DefaultPageSize</td></tr>
<tr class="memdesc:aec977d5e2434be57c192143dd65870e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default page size. <a href="#aec977d5e2434be57c192143dd65870e9">More...</a><br /></td></tr>
<tr class="separator:aec977d5e2434be57c192143dd65870e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a3fa5aecd9a231cbeb23e6680f07537cc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_query_options.html#a3fa5aecd9a231cbeb23e6680f07537cc">Local</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a3fa5aecd9a231cbeb23e6680f07537cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Local flag. When set query will be executed only on local node, so only local entries will be returned as query result. <a href="#a3fa5aecd9a231cbeb23e6680f07537cc">More...</a><br /></td></tr>
<tr class="separator:a3fa5aecd9a231cbeb23e6680f07537cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4000c3d99740591af5b154ea05b632b3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_query_options.html#a4000c3d99740591af5b154ea05b632b3">PageSize</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a4000c3d99740591af5b154ea05b632b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Page size, defaults to <a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_query_options.html#aec977d5e2434be57c192143dd65870e9" title="Default page size. ">DefaultPageSize</a>. <a href="#a4000c3d99740591af5b154ea05b632b3">More...</a><br /></td></tr>
<tr class="separator:a4000c3d99740591af5b154ea05b632b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a836f256f3e3d8f0446b4bce7b372b97a"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_query_options.html#a836f256f3e3d8f0446b4bce7b372b97a">TableName</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a836f256f3e3d8f0446b4bce7b372b97a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the name of the table. <a href="#a836f256f3e3d8f0446b4bce7b372b97a">More...</a><br /></td></tr>
<tr class="separator:a836f256f3e3d8f0446b4bce7b372b97a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af68462083ae04dddc36c57a96d735d22"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_query_options.html#af68462083ae04dddc36c57a96d735d22">EnableDistributedJoins</a><code> [get, set]</code></td></tr>
<tr class="memdesc:af68462083ae04dddc36c57a96d735d22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets a value indicating whether distributed joins should be enabled for this query. <a href="#af68462083ae04dddc36c57a96d735d22">More...</a><br /></td></tr>
<tr class="separator:af68462083ae04dddc36c57a96d735d22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4aa0ce427edaa1ab9d8c7d1eeb69a931"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_query_options.html#a4aa0ce427edaa1ab9d8c7d1eeb69a931">EnforceJoinOrder</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a4aa0ce427edaa1ab9d8c7d1eeb69a931"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets a value indicating whether join order of tables should be enforced. <a href="#a4aa0ce427edaa1ab9d8c7d1eeb69a931">More...</a><br /></td></tr>
<tr class="separator:a4aa0ce427edaa1ab9d8c7d1eeb69a931"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d4fe0bb2fe9bebf72ce35294a6c6caf"><td class="memItemLeft" align="right" valign="top">TimeSpan&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_query_options.html#a5d4fe0bb2fe9bebf72ce35294a6c6caf">Timeout</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a5d4fe0bb2fe9bebf72ce35294a6c6caf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the query timeout. Query will be automatically cancelled if the execution timeout is exceeded. Default is TimeSpan.Zero, which means no timeout. <a href="#a5d4fe0bb2fe9bebf72ce35294a6c6caf">More...</a><br /></td></tr>
<tr class="separator:a5d4fe0bb2fe9bebf72ce35294a6c6caf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a993a15c5d9e9b35a383fe1df853caa16"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_query_options.html#a993a15c5d9e9b35a383fe1df853caa16">ReplicatedOnly</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a993a15c5d9e9b35a383fe1df853caa16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets a value indicating whether this query contains only replicated tables. This is a hint for potentially more effective execution. <a href="#a993a15c5d9e9b35a383fe1df853caa16">More...</a><br /></td></tr>
<tr class="separator:a993a15c5d9e9b35a383fe1df853caa16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a300047c8b33371967b9689d9cee8f739"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_query_options.html#a300047c8b33371967b9689d9cee8f739">Colocated</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a300047c8b33371967b9689d9cee8f739"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets a value indicating whether this query operates on colocated data. <a href="#a300047c8b33371967b9689d9cee8f739">More...</a><br /></td></tr>
<tr class="separator:a300047c8b33371967b9689d9cee8f739"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"></div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="acd75dba01e9582d10d6aead79b5b4f4d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Apache.Ignite.Linq.QueryOptions.QueryOptions </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aec977d5e2434be57c192143dd65870e9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int Apache.Ignite.Linq.QueryOptions.DefaultPageSize = SqlFieldsQuery.DefaultPageSize</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a300047c8b33371967b9689d9cee8f739"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Apache.Ignite.Linq.QueryOptions.Colocated</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Whenever Ignite executes a distributed query, it sends sub-queries to individual cluster members. If you know in advance that the elements of your query selection are colocated together on the same node and you group by colocated key (primary or affinity key), then Ignite can make significant performance and network optimizations by grouping data on remote nodes. </p>
</div>
</div>
<a class="anchor" id="af68462083ae04dddc36c57a96d735d22"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Apache.Ignite.Linq.QueryOptions.EnableDistributedJoins</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>When disabled, join results will only contain colocated data (joins work locally). When enabled, joins work as expected, no matter how the data is distributed. </p>
<p><code>true</code> if enable distributed joins should be enabled; otherwise, <code>false</code>. </p>
</div>
</div>
<a class="anchor" id="a4aa0ce427edaa1ab9d8c7d1eeb69a931"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Apache.Ignite.Linq.QueryOptions.EnforceJoinOrder</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>When true, query optimizer will not reorder tables in join. </p>
<p>It is not recommended to enable this property until you are sure that your indexes and the query itself are correct and tuned as much as possible but query optimizer still produces wrong join order. </p>
<p><code>true</code> if join order should be enforced; otherwise, <code>false</code>. </p>
</div>
</div>
<a class="anchor" id="a3fa5aecd9a231cbeb23e6680f07537cc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Apache.Ignite.Linq.QueryOptions.Local</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Defaults to <code>false</code>. </p>
</div>
</div>
<a class="anchor" id="a4000c3d99740591af5b154ea05b632b3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Apache.Ignite.Linq.QueryOptions.PageSize</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a993a15c5d9e9b35a383fe1df853caa16"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Apache.Ignite.Linq.QueryOptions.ReplicatedOnly</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a836f256f3e3d8f0446b4bce7b372b97a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string Apache.Ignite.Linq.QueryOptions.TableName</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Table name is equal to short class name of a cache value. When a cache has only one type of values, or only one QueryEntity defined, table name will be inferred and can be omitted (null). </p>
<p>The name of the table. </p>
</div>
</div>
<a class="anchor" id="a5d4fe0bb2fe9bebf72ce35294a6c6caf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">TimeSpan Apache.Ignite.Linq.QueryOptions.Timeout</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespace_apache.html">Apache</a></li><li class="navelem"><a class="el" href="namespace_apache_1_1_ignite.html">Ignite</a></li><li class="navelem"><a class="el" href="namespace_apache_1_1_ignite_1_1_linq.html">Linq</a></li><li class="navelem"><a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_query_options.html">QueryOptions</a></li>
<li class="footer">Generated on Thu Jul 20 2017 19:19:56 for Apache Ignite.NET by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>