blob: 09f63ff03c7bf8f69550af1b7a8dd96867e8f4f1 [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/1.8.0/dotnetdoc/class_apache_1_1_ignite_1_1_linq_1_1_cache_linq_extensions.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.9.1"/>
<title>Apache Ignite.NET: Apache.Ignite.Linq.CacheLinqExtensions 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 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.9.1 -->
</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_cache_linq_extensions.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="class_apache_1_1_ignite_1_1_linq_1_1_cache_linq_extensions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Ignite.Linq.CacheLinqExtensions Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Extensions methods for ICache&lt;TK,TV&gt;.
<a href="class_apache_1_1_ignite_1_1_linq_1_1_cache_linq_extensions.html#details">More...</a></p>
<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:a660b42d6c26414447cc455248634cef8"><td class="memItemLeft" align="right" valign="top">static IQueryable&lt; <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache_entry.html">ICacheEntry</a>&lt; TKey, TValue &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_cache_linq_extensions.html#a660b42d6c26414447cc455248634cef8">AsCacheQueryable&lt; TKey, TValue &gt;</a> (this <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache.html">ICache</a>&lt; TKey, TValue &gt; cache)</td></tr>
<tr class="memdesc:a660b42d6c26414447cc455248634cef8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets an IQueryable&lt;T&gt; instance over this cache. <a href="#a660b42d6c26414447cc455248634cef8">More...</a><br /></td></tr>
<tr class="separator:a660b42d6c26414447cc455248634cef8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21439b31f231ab9965ae4ac3d80f5d98"><td class="memItemLeft" align="right" valign="top">static IQueryable&lt; <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache_entry.html">ICacheEntry</a>&lt; TKey, TValue &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_cache_linq_extensions.html#a21439b31f231ab9965ae4ac3d80f5d98">AsCacheQueryable&lt; TKey, TValue &gt;</a> (this <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache.html">ICache</a>&lt; TKey, TValue &gt; cache, bool local)</td></tr>
<tr class="memdesc:a21439b31f231ab9965ae4ac3d80f5d98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets an IQueryable&lt;T&gt; instance over this cache. <a href="#a21439b31f231ab9965ae4ac3d80f5d98">More...</a><br /></td></tr>
<tr class="separator:a21439b31f231ab9965ae4ac3d80f5d98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad43c6788659774cfcd7ff39727e34ca5"><td class="memItemLeft" align="right" valign="top">static IQueryable&lt; <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache_entry.html">ICacheEntry</a>&lt; TKey, TValue &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_cache_linq_extensions.html#ad43c6788659774cfcd7ff39727e34ca5">AsCacheQueryable&lt; TKey, TValue &gt;</a> (this <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache.html">ICache</a>&lt; TKey, TValue &gt; cache, bool local, string tableName)</td></tr>
<tr class="memdesc:ad43c6788659774cfcd7ff39727e34ca5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets an IQueryable&lt;T&gt; instance over this cache. <a href="#ad43c6788659774cfcd7ff39727e34ca5">More...</a><br /></td></tr>
<tr class="separator:ad43c6788659774cfcd7ff39727e34ca5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a614093f5bc5ca8b131dfe90655295db4"><td class="memItemLeft" align="right" valign="top">static IQueryable&lt; <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache_entry.html">ICacheEntry</a>&lt; TKey, TValue &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_cache_linq_extensions.html#a614093f5bc5ca8b131dfe90655295db4">AsCacheQueryable&lt; TKey, TValue &gt;</a> (this <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache.html">ICache</a>&lt; TKey, TValue &gt; cache, <a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_query_options.html">QueryOptions</a> queryOptions)</td></tr>
<tr class="memdesc:a614093f5bc5ca8b131dfe90655295db4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets an IQueryable&lt;T&gt; instance over this cache. <a href="#a614093f5bc5ca8b131dfe90655295db4">More...</a><br /></td></tr>
<tr class="separator:a614093f5bc5ca8b131dfe90655295db4"><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">Member Function Documentation</h2>
<a class="anchor" id="a660b42d6c26414447cc455248634cef8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static IQueryable&lt;<a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache_entry.html">ICacheEntry</a>&lt;TKey, TValue&gt; &gt; Apache.Ignite.Linq.CacheLinqExtensions.AsCacheQueryable&lt; TKey, TValue &gt; </td>
<td>(</td>
<td class="paramtype">this <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache.html">ICache</a>&lt; TKey, TValue &gt;&#160;</td>
<td class="paramname"><em>cache</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resulting query will be translated to cache SQL query and executed over the cache instance via either <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache.html#a17cc696aa7bc594df0e5ec044363da03" title="Queries cache. ">ICache&lt;TK,TV&gt;.Query</a> or <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache.html#ae37ac1bb9055cd1c09ec346564fb2e1a" title="Queries separate entry fields. ">ICache&lt;TK,TV&gt;.QueryFields</a>, depending on requested result. </p>
<p>Result of this method (and subsequent query) can be cast to <a class="el" href="interface_apache_1_1_ignite_1_1_linq_1_1_i_cache_queryable.html" title="Common interface for cache queryables. ">ICacheQueryable</a> for introspection. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">TKey</td><td>The type of the key.</td></tr>
<tr><td class="paramname">TValue</td><td>The type of the value.</td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache</td><td>The cache.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>IQueryable&lt;T&gt; instance over this cache.</dd></dl>
</div>
</div>
<a class="anchor" id="a21439b31f231ab9965ae4ac3d80f5d98"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static IQueryable&lt;<a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache_entry.html">ICacheEntry</a>&lt;TKey, TValue&gt; &gt; Apache.Ignite.Linq.CacheLinqExtensions.AsCacheQueryable&lt; TKey, TValue &gt; </td>
<td>(</td>
<td class="paramtype">this <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache.html">ICache</a>&lt; TKey, TValue &gt;&#160;</td>
<td class="paramname"><em>cache</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>local</em>&#160;</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resulting query will be translated to cache SQL query and executed over the cache instance via either <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache.html#a17cc696aa7bc594df0e5ec044363da03" title="Queries cache. ">ICache&lt;TK,TV&gt;.Query</a> or <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache.html#ae37ac1bb9055cd1c09ec346564fb2e1a" title="Queries separate entry fields. ">ICache&lt;TK,TV&gt;.QueryFields</a>, depending on requested result. </p>
<p>Result of this method (and subsequent query) can be cast to <a class="el" href="interface_apache_1_1_ignite_1_1_linq_1_1_i_cache_queryable.html" title="Common interface for cache queryables. ">ICacheQueryable</a> for introspection. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">TKey</td><td>The type of the key.</td></tr>
<tr><td class="paramname">TValue</td><td>The type of the value.</td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache</td><td>The cache.</td></tr>
<tr><td class="paramname">local</td><td>Local flag. When set query will be executed only on local node, so only local entries will be returned as query result.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>IQueryable&lt;T&gt; instance over this cache.</dd></dl>
</div>
</div>
<a class="anchor" id="ad43c6788659774cfcd7ff39727e34ca5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static IQueryable&lt;<a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache_entry.html">ICacheEntry</a>&lt;TKey, TValue&gt; &gt; Apache.Ignite.Linq.CacheLinqExtensions.AsCacheQueryable&lt; TKey, TValue &gt; </td>
<td>(</td>
<td class="paramtype">this <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache.html">ICache</a>&lt; TKey, TValue &gt;&#160;</td>
<td class="paramname"><em>cache</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>local</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>tableName</em>&#160;</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resulting query will be translated to cache SQL query and executed over the cache instance via either <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache.html#a17cc696aa7bc594df0e5ec044363da03" title="Queries cache. ">ICache&lt;TK,TV&gt;.Query</a> or <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache.html#ae37ac1bb9055cd1c09ec346564fb2e1a" title="Queries separate entry fields. ">ICache&lt;TK,TV&gt;.QueryFields</a>, depending on requested result. </p>
<p>Result of this method (and subsequent query) can be cast to <a class="el" href="interface_apache_1_1_ignite_1_1_linq_1_1_i_cache_queryable.html" title="Common interface for cache queryables. ">ICacheQueryable</a> for introspection. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">TKey</td><td>The type of the key.</td></tr>
<tr><td class="paramname">TValue</td><td>The type of the value.</td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache</td><td>The cache.</td></tr>
<tr><td class="paramname">local</td><td>Local flag. When set query will be executed only on local node, so only local entries will be returned as query result.</td></tr>
<tr><td class="paramname">tableName</td><td>Name of the table. </td></tr>
</table>
</dd>
</dl>
<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. </p>
<dl class="section return"><dt>Returns</dt><dd>IQueryable&lt;T&gt; instance over this cache.</dd></dl>
</div>
</div>
<a class="anchor" id="a614093f5bc5ca8b131dfe90655295db4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static IQueryable&lt;<a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache_entry.html">ICacheEntry</a>&lt;TKey, TValue&gt; &gt; Apache.Ignite.Linq.CacheLinqExtensions.AsCacheQueryable&lt; TKey, TValue &gt; </td>
<td>(</td>
<td class="paramtype">this <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache.html">ICache</a>&lt; TKey, TValue &gt;&#160;</td>
<td class="paramname"><em>cache</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_apache_1_1_ignite_1_1_linq_1_1_query_options.html">QueryOptions</a>&#160;</td>
<td class="paramname"><em>queryOptions</em>&#160;</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resulting query will be translated to cache SQL query and executed over the cache instance via either <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache.html#a17cc696aa7bc594df0e5ec044363da03" title="Queries cache. ">ICache&lt;TK,TV&gt;.Query</a> or <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_cache_1_1_i_cache.html#ae37ac1bb9055cd1c09ec346564fb2e1a" title="Queries separate entry fields. ">ICache&lt;TK,TV&gt;.QueryFields</a>, depending on requested result. </p>
<p>Result of this method (and subsequent query) can be cast to <a class="el" href="interface_apache_1_1_ignite_1_1_linq_1_1_i_cache_queryable.html" title="Common interface for cache queryables. ">ICacheQueryable</a> for introspection. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">TKey</td><td>The type of the key.</td></tr>
<tr><td class="paramname">TValue</td><td>The type of the value.</td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache</td><td>The cache.</td></tr>
<tr><td class="paramname">queryOptions</td><td>The query options.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>IQueryable&lt;T&gt; instance over this cache. </dd></dl>
</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_cache_linq_extensions.html">CacheLinqExtensions</a></li>
<li class="footer">Generated on Mon Dec 5 2016 14:37:40 for Apache Ignite.NET by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
</ul>
</div>
</body>
</html>