blob: feaa3c14814eda6dfd095e2242e314e7a5135550 [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_core_1_1_cache_1_1_configuration_1_1_query_entity.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.Core.Cache.Configuration.QueryEntity 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_core_1_1_cache_1_1_configuration_1_1_query_entity.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_entity-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Ignite.Core.Cache.Configuration.QueryEntity Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Query entity is a description of cache entry (composed of key and value) in a way of how it must be indexed and can be queried.
<a href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_entity.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:a58c96b784260e2f35ff7c692777cd6a7"><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_core_1_1_cache_1_1_configuration_1_1_query_entity.html#a58c96b784260e2f35ff7c692777cd6a7">QueryEntity</a> ()</td></tr>
<tr class="memdesc:a58c96b784260e2f35ff7c692777cd6a7"><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_core_1_1_cache_1_1_configuration_1_1_query_entity.html" title="Query entity is a description of cache entry (composed of key and value) in a way of how it must be i...">QueryEntity</a> class. <a href="#a58c96b784260e2f35ff7c692777cd6a7">More...</a><br /></td></tr>
<tr class="separator:a58c96b784260e2f35ff7c692777cd6a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40091f3cffe60aa6fb2616053e79e27d"><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_core_1_1_cache_1_1_configuration_1_1_query_entity.html#a40091f3cffe60aa6fb2616053e79e27d">QueryEntity</a> (Type valueType)</td></tr>
<tr class="memdesc:a40091f3cffe60aa6fb2616053e79e27d"><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_core_1_1_cache_1_1_configuration_1_1_query_entity.html" title="Query entity is a description of cache entry (composed of key and value) in a way of how it must be i...">QueryEntity</a> class. <a href="#a40091f3cffe60aa6fb2616053e79e27d">More...</a><br /></td></tr>
<tr class="separator:a40091f3cffe60aa6fb2616053e79e27d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfe240d76c30b0718d3f39927b5bc534"><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_core_1_1_cache_1_1_configuration_1_1_query_entity.html#abfe240d76c30b0718d3f39927b5bc534">QueryEntity</a> (Type keyType, Type valueType)</td></tr>
<tr class="memdesc:abfe240d76c30b0718d3f39927b5bc534"><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_core_1_1_cache_1_1_configuration_1_1_query_entity.html" title="Query entity is a description of cache entry (composed of key and value) in a way of how it must be i...">QueryEntity</a> class. <a href="#abfe240d76c30b0718d3f39927b5bc534">More...</a><br /></td></tr>
<tr class="separator:abfe240d76c30b0718d3f39927b5bc534"><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:a04d1e7cfd314c0b4e1b9bb9284176b20"><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_core_1_1_cache_1_1_configuration_1_1_query_entity.html#a04d1e7cfd314c0b4e1b9bb9284176b20">KeyTypeName</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a04d1e7cfd314c0b4e1b9bb9284176b20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets key Java type name. <a href="#a04d1e7cfd314c0b4e1b9bb9284176b20">More...</a><br /></td></tr>
<tr class="separator:a04d1e7cfd314c0b4e1b9bb9284176b20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e36a76808f42ae9c7e776981fd6a8bc"><td class="memItemLeft" align="right" valign="top">Type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_entity.html#a1e36a76808f42ae9c7e776981fd6a8bc">KeyType</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a1e36a76808f42ae9c7e776981fd6a8bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the type of the key. <a href="#a1e36a76808f42ae9c7e776981fd6a8bc">More...</a><br /></td></tr>
<tr class="separator:a1e36a76808f42ae9c7e776981fd6a8bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae472e1570ef3791a1d4dad9a9ae175e1"><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_core_1_1_cache_1_1_configuration_1_1_query_entity.html#ae472e1570ef3791a1d4dad9a9ae175e1">ValueTypeName</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ae472e1570ef3791a1d4dad9a9ae175e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets value Java type name. <a href="#ae472e1570ef3791a1d4dad9a9ae175e1">More...</a><br /></td></tr>
<tr class="separator:ae472e1570ef3791a1d4dad9a9ae175e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a892d37e26e516b1ee1533c4e1fbd8518"><td class="memItemLeft" align="right" valign="top">Type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_entity.html#a892d37e26e516b1ee1533c4e1fbd8518">ValueType</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a892d37e26e516b1ee1533c4e1fbd8518"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the type of the value. <a href="#a892d37e26e516b1ee1533c4e1fbd8518">More...</a><br /></td></tr>
<tr class="separator:a892d37e26e516b1ee1533c4e1fbd8518"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3817aaa508696dfcc50cce2d9223a11"><td class="memItemLeft" align="right" valign="top">ICollection&lt; <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_field.html">QueryField</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_entity.html#aa3817aaa508696dfcc50cce2d9223a11">Fields</a><code> [get, set]</code></td></tr>
<tr class="memdesc:aa3817aaa508696dfcc50cce2d9223a11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets query fields, a map from field name to Java type name. The order of fields defines the order of columns returned by the 'select *' queries. <a href="#aa3817aaa508696dfcc50cce2d9223a11">More...</a><br /></td></tr>
<tr class="separator:aa3817aaa508696dfcc50cce2d9223a11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19066e676b978cfecf8cff7a6bdf4988"><td class="memItemLeft" align="right" valign="top">ICollection&lt; <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_alias.html">QueryAlias</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_entity.html#a19066e676b978cfecf8cff7a6bdf4988">Aliases</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a19066e676b978cfecf8cff7a6bdf4988"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets field name aliases: mapping from full name in dot notation to an alias that will be used as SQL column name. Example: {"parent.name" -&gt; "parentName"}. <a href="#a19066e676b978cfecf8cff7a6bdf4988">More...</a><br /></td></tr>
<tr class="separator:a19066e676b978cfecf8cff7a6bdf4988"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a512b1c29ea74e215af003b1cdb8ee293"><td class="memItemLeft" align="right" valign="top">ICollection&lt; <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_index.html">QueryIndex</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_entity.html#a512b1c29ea74e215af003b1cdb8ee293">Indexes</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a512b1c29ea74e215af003b1cdb8ee293"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the query indexes. <a href="#a512b1c29ea74e215af003b1cdb8ee293">More...</a><br /></td></tr>
<tr class="separator:a512b1c29ea74e215af003b1cdb8ee293"><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="a58c96b784260e2f35ff7c692777cd6a7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Apache.Ignite.Core.Cache.Configuration.QueryEntity.QueryEntity </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a40091f3cffe60aa6fb2616053e79e27d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Apache.Ignite.Core.Cache.Configuration.QueryEntity.QueryEntity </td>
<td>(</td>
<td class="paramtype">Type&#160;</td>
<td class="paramname"><em>valueType</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">valueType</td><td>Type of the cache entry value.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abfe240d76c30b0718d3f39927b5bc534"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Apache.Ignite.Core.Cache.Configuration.QueryEntity.QueryEntity </td>
<td>(</td>
<td class="paramtype">Type&#160;</td>
<td class="paramname"><em>keyType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Type&#160;</td>
<td class="paramname"><em>valueType</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keyType</td><td>Type of the key.</td></tr>
<tr><td class="paramname">valueType</td><td>Type of the value.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a19066e676b978cfecf8cff7a6bdf4988"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ICollection&lt;<a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_alias.html">QueryAlias</a>&gt; Apache.Ignite.Core.Cache.Configuration.QueryEntity.Aliases</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="aa3817aaa508696dfcc50cce2d9223a11"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ICollection&lt;<a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_field.html">QueryField</a>&gt; Apache.Ignite.Core.Cache.Configuration.QueryEntity.Fields</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="a512b1c29ea74e215af003b1cdb8ee293"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ICollection&lt;<a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_index.html">QueryIndex</a>&gt; Apache.Ignite.Core.Cache.Configuration.QueryEntity.Indexes</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="a1e36a76808f42ae9c7e776981fd6a8bc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Type Apache.Ignite.Core.Cache.Configuration.QueryEntity.KeyType</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>This is a shortcut for <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_entity.html#a04d1e7cfd314c0b4e1b9bb9284176b20" title="Gets or sets key Java type name. ">KeyTypeName</a>. Getter will return null for non-primitive types. </p>
<p>Setting this property will overwrite <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_entity.html#aa3817aaa508696dfcc50cce2d9223a11" title="Gets or sets query fields, a map from field name to Java type name. The order of fields defines the o...">Fields</a> and <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_entity.html#a512b1c29ea74e215af003b1cdb8ee293" title="Gets or sets the query indexes. ">Indexes</a> according to <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_sql_field_attribute.html" title="Marks field or property for SQL queries. ">QuerySqlFieldAttribute</a>, if any. </p>
</div>
</div>
<a class="anchor" id="a04d1e7cfd314c0b4e1b9bb9284176b20"></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.Core.Cache.Configuration.QueryEntity.KeyTypeName</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="a892d37e26e516b1ee1533c4e1fbd8518"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Type Apache.Ignite.Core.Cache.Configuration.QueryEntity.ValueType</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>This is a shortcut for <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_entity.html#ae472e1570ef3791a1d4dad9a9ae175e1" title="Gets or sets value Java type name. ">ValueTypeName</a>. Getter will return null for non-primitive types. </p>
<p>Setting this property will overwrite <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_entity.html#aa3817aaa508696dfcc50cce2d9223a11" title="Gets or sets query fields, a map from field name to Java type name. The order of fields defines the o...">Fields</a> and <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_entity.html#a512b1c29ea74e215af003b1cdb8ee293" title="Gets or sets the query indexes. ">Indexes</a> according to <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_sql_field_attribute.html" title="Marks field or property for SQL queries. ">QuerySqlFieldAttribute</a>, if any. </p>
</div>
</div>
<a class="anchor" id="ae472e1570ef3791a1d4dad9a9ae175e1"></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.Core.Cache.Configuration.QueryEntity.ValueTypeName</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_core.html">Core</a></li><li class="navelem"><a class="el" href="namespace_apache_1_1_ignite_1_1_core_1_1_cache.html">Cache</a></li><li class="navelem"><a class="el" href="namespace_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration.html">Configuration</a></li><li class="navelem"><a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_cache_1_1_configuration_1_1_query_entity.html">QueryEntity</a></li>
<li class="footer">Generated on Mon Dec 5 2016 14:37:39 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>