blob: 92365f7abbcd62f3406068a17405f50b83f6a3ec [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Interface IDbCachingPolicy
| Apache Ignite.NET </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Interface IDbCachingPolicy
| Apache Ignite.NET ">
<meta name="generator" content="docfx 2.58.4.0">
<link rel="shortcut icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/logo_ignite_32_32.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Apache.Ignite.EntityFramework.IDbCachingPolicy">
<h1 id="Apache_Ignite_EntityFramework_IDbCachingPolicy" data-uid="Apache.Ignite.EntityFramework.IDbCachingPolicy" class="text-break">Interface IDbCachingPolicy
</h1>
<div class="markdown level0 summary"><p>Caching policy: defines which queries should be cached.</p>
</div>
<div class="markdown level0 conceptual"></div>
<h6><strong>Namespace</strong>: <a class="xref" href="Apache.Ignite.EntityFramework.html">Apache.Ignite.EntityFramework</a></h6>
<h6><strong>Assembly</strong>: Apache.Ignite.EntityFramework.dll</h6>
<h5 id="Apache_Ignite_EntityFramework_IDbCachingPolicy_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IDbCachingPolicy</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<a id="Apache_Ignite_EntityFramework_IDbCachingPolicy_CanBeCached_" data-uid="Apache.Ignite.EntityFramework.IDbCachingPolicy.CanBeCached*"></a>
<h4 id="Apache_Ignite_EntityFramework_IDbCachingPolicy_CanBeCached_Apache_Ignite_EntityFramework_DbQueryInfo_" data-uid="Apache.Ignite.EntityFramework.IDbCachingPolicy.CanBeCached(Apache.Ignite.EntityFramework.DbQueryInfo)">CanBeCached(DbQueryInfo)</h4>
<div class="markdown level1 summary"><p>Determines whether the specified query can be cached.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool CanBeCached(DbQueryInfo queryInfo)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.EntityFramework.DbQueryInfo.html">DbQueryInfo</a></td>
<td><span class="parametername">queryInfo</span></td>
<td><p>The query information.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p><code>true</code> if the specified query can be cached; otherwise, <code>false</code>.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_EntityFramework_IDbCachingPolicy_CanBeCached_" data-uid="Apache.Ignite.EntityFramework.IDbCachingPolicy.CanBeCached*"></a>
<h4 id="Apache_Ignite_EntityFramework_IDbCachingPolicy_CanBeCached_Apache_Ignite_EntityFramework_DbQueryInfo_System_Int32_" data-uid="Apache.Ignite.EntityFramework.IDbCachingPolicy.CanBeCached(Apache.Ignite.EntityFramework.DbQueryInfo,System.Int32)">CanBeCached(DbQueryInfo, Int32)</h4>
<div class="markdown level1 summary"><p>Determines whether specified number of rows should be cached.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool CanBeCached(DbQueryInfo queryInfo, int rowCount)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.EntityFramework.DbQueryInfo.html">DbQueryInfo</a></td>
<td><span class="parametername">queryInfo</span></td>
<td><p>The query information.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">rowCount</span></td>
<td><p>The count of fetched rows.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_EntityFramework_IDbCachingPolicy_GetCachingMode_" data-uid="Apache.Ignite.EntityFramework.IDbCachingPolicy.GetCachingMode*"></a>
<h4 id="Apache_Ignite_EntityFramework_IDbCachingPolicy_GetCachingMode_Apache_Ignite_EntityFramework_DbQueryInfo_" data-uid="Apache.Ignite.EntityFramework.IDbCachingPolicy.GetCachingMode(Apache.Ignite.EntityFramework.DbQueryInfo)">GetCachingMode(DbQueryInfo)</h4>
<div class="markdown level1 summary"><p>Gets the caching strategy for a give query.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">DbCachingMode GetCachingMode(DbQueryInfo queryInfo)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.EntityFramework.DbQueryInfo.html">DbQueryInfo</a></td>
<td><span class="parametername">queryInfo</span></td>
<td><p>The query information.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.EntityFramework.DbCachingMode.html">DbCachingMode</a></td>
<td><p>Caching strategy for the query.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_EntityFramework_IDbCachingPolicy_GetExpirationTimeout_" data-uid="Apache.Ignite.EntityFramework.IDbCachingPolicy.GetExpirationTimeout*"></a>
<h4 id="Apache_Ignite_EntityFramework_IDbCachingPolicy_GetExpirationTimeout_Apache_Ignite_EntityFramework_DbQueryInfo_" data-uid="Apache.Ignite.EntityFramework.IDbCachingPolicy.GetExpirationTimeout(Apache.Ignite.EntityFramework.DbQueryInfo)">GetExpirationTimeout(DbQueryInfo)</h4>
<div class="markdown level1 summary"><p>Gets the absolute expiration timeout for a given query.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">TimeSpan GetExpirationTimeout(DbQueryInfo queryInfo)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.EntityFramework.DbQueryInfo.html">DbQueryInfo</a></td>
<td><span class="parametername">queryInfo</span></td>
<td><p>The query information.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.TimeSpan</span></td>
<td><p>Expiration timeout. <span class="xref">System.TimeSpan.MaxValue</span> for no expiration.</p>
</td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
© 2015 - 2019 The Apache Software Foundation
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>