blob: f40db091d6b5cea7827de9166d31355280fbc3e2 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<link rel="canonical" href="https://ignite.apache.org/releases/2.4.0/dotnetdoc/api/Apache.Ignite.Core.Cache.Configuration.QueryEntity.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class QueryEntity
| Apache Ignite.NET </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class QueryEntity
| Apache Ignite.NET ">
<meta name="generator" content="docfx 2.24.0.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="../">
<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 data-spy="scroll" data-target="#affix">
<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"></div>
<div class="sr-items"></div>
<ul id="pagination"></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.Core.Cache.Configuration.QueryEntity">
<h1 id="Apache_Ignite_Core_Cache_Configuration_QueryEntity" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity" class="text-break">Class QueryEntity
</h1>
<div class="markdown level0 summary"><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.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">QueryEntity</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.html">Apache.Ignite.Core.Cache.Configuration</a></h6>
<h6><strong>Assembly</strong>: Apache.Ignite.Core.dll</h6>
<h5 id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class QueryEntity : IQueryEntityInternal, IBinaryRawWriteAware, IBinaryRawWriteAware&lt;IBinaryRawWriter&gt;</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Apache_Ignite_Core_Cache_Configuration_QueryEntity__ctor_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.#ctor*"></a>
<h4 id="Apache_Ignite_Core_Cache_Configuration_QueryEntity__ctor" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.#ctor">QueryEntity()</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryEntity.html">QueryEntity</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public QueryEntity()</code></pre>
</div>
<a id="Apache_Ignite_Core_Cache_Configuration_QueryEntity__ctor_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.#ctor*"></a>
<h4 id="Apache_Ignite_Core_Cache_Configuration_QueryEntity__ctor_System_Type_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.#ctor(System.Type)">QueryEntity(Type)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryEntity.html">QueryEntity</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public QueryEntity(Type valueType)</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><span class="xref">System.Type</span></td>
<td><span class="parametername">valueType</span></td>
<td><p>Type of the cache entry value.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Cache_Configuration_QueryEntity__ctor_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.#ctor*"></a>
<h4 id="Apache_Ignite_Core_Cache_Configuration_QueryEntity__ctor_System_Type_System_Type_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.#ctor(System.Type,System.Type)">QueryEntity(Type, Type)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryEntity.html">QueryEntity</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public QueryEntity(Type keyType, Type valueType)</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><span class="xref">System.Type</span></td>
<td><span class="parametername">keyType</span></td>
<td><p>Type of the key.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Type</span></td>
<td><span class="parametername">valueType</span></td>
<td><p>Type of the value.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_Aliases_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.Aliases*"></a>
<h4 id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_Aliases" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.Aliases">Aliases</h4>
<div class="markdown level1 summary"><p>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: {&quot;parent.name&quot; -&gt; &quot;parentName&quot;}.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ICollection&lt;QueryAlias&gt; Aliases { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Collections.Generic.ICollection</span>&lt;<a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryAlias.html">QueryAlias</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_Fields_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.Fields*"></a>
<h4 id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_Fields" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.Fields">Fields</h4>
<div class="markdown level1 summary"><p>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 &apos;select *&apos; queries.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ICollection&lt;QueryField&gt; Fields { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Collections.Generic.ICollection</span>&lt;<a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryField.html">QueryField</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_Indexes_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.Indexes*"></a>
<h4 id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_Indexes" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.Indexes">Indexes</h4>
<div class="markdown level1 summary"><p>Gets or sets the query indexes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ICollection&lt;QueryIndex&gt; Indexes { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Collections.Generic.ICollection</span>&lt;<a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryIndex.html">QueryIndex</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_KeyFieldName_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.KeyFieldName*"></a>
<h4 id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_KeyFieldName" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.KeyFieldName">KeyFieldName</h4>
<div class="markdown level1 summary"><p>Gets or sets the name of the field that is used to denote the entire key.
<p>
By default, entite key can be accessed with a special &quot;_key&quot; field name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string KeyFieldName { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_KeyType_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.KeyType*"></a>
<h4 id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_KeyType" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.KeyType">KeyType</h4>
<div class="markdown level1 summary"><p>Gets or sets the type of the key.
<p>
This is a shortcut for <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryEntity.html#Apache_Ignite_Core_Cache_Configuration_QueryEntity_KeyTypeName">KeyTypeName</a>. Getter will return null for non-primitive types.
<p>
Setting this property will overwrite <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryEntity.html#Apache_Ignite_Core_Cache_Configuration_QueryEntity_Fields">Fields</a> and <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryEntity.html#Apache_Ignite_Core_Cache_Configuration_QueryEntity_Indexes">Indexes</a> according to
<a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QuerySqlFieldAttribute.html">QuerySqlFieldAttribute</a>, if any.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Type KeyType { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Type</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_KeyTypeName_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.KeyTypeName*"></a>
<h4 id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_KeyTypeName" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.KeyTypeName">KeyTypeName</h4>
<div class="markdown level1 summary"><p>Gets or sets key Java type name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string KeyTypeName { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_TableName_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.TableName*"></a>
<h4 id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_TableName" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.TableName">TableName</h4>
<div class="markdown level1 summary"><p>Gets or sets the name of the SQL table.
When not set, value type name is used.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string TableName { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_ValueFieldName_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.ValueFieldName*"></a>
<h4 id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_ValueFieldName" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.ValueFieldName">ValueFieldName</h4>
<div class="markdown level1 summary"><p>Gets or sets the name of the field that is used to denote the entire value.
<p>
By default, entite value can be accessed with a special &quot;_val&quot; field name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ValueFieldName { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_ValueType_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.ValueType*"></a>
<h4 id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_ValueType" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.ValueType">ValueType</h4>
<div class="markdown level1 summary"><p>Gets or sets the type of the value.
<p>
This is a shortcut for <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryEntity.html#Apache_Ignite_Core_Cache_Configuration_QueryEntity_ValueTypeName">ValueTypeName</a>. Getter will return null for non-primitive types.
<p>
Setting this property will overwrite <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryEntity.html#Apache_Ignite_Core_Cache_Configuration_QueryEntity_Fields">Fields</a> and <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryEntity.html#Apache_Ignite_Core_Cache_Configuration_QueryEntity_Indexes">Indexes</a> according to
<a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QuerySqlFieldAttribute.html">QuerySqlFieldAttribute</a>, if any.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Type ValueType { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Type</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_ValueTypeName_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.ValueTypeName*"></a>
<h4 id="Apache_Ignite_Core_Cache_Configuration_QueryEntity_ValueTypeName" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryEntity.ValueTypeName">ValueTypeName</h4>
<div class="markdown level1 summary"><p>Gets or sets value Java type name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ValueTypeName { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.String</span></td>
<td></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">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</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 - 2018 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>