﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
<!-- Yandex.Metrika counter -->
    <script type="text/javascript" >
      (function(m,e,t,r,i,k,a){m[i]=m[i]||function(){(m[i].a=m[i].a||[]).push(arguments)};
      m[i].l=1*new Date();k=e.createElement(t),a=e.getElementsByTagName(t)[0],k.async=1,k.src=r,a.parentNode.insertBefore(k,a)})
      (window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym");
    
      ym(72949126, "init", {
           clickmap:true,
           trackLinks:true,
           accurateTrackBounce:true,
           webvisor:true
      });
    </script>
    <noscript><div><img src="https://mc.yandex.ru/watch/72949126" style="position:absolute; left:-9999px;" alt="" /></div></noscript>
    <!-- /Yandex.Metrika counter -->
<script type='text/javascript'>
    window.__lo_site_id = 284467;
    
      (function() {
        var wa = document.createElement('script'); wa.type = 'text/javascript'; wa.async = true;
        wa.src = 'https://d10lpsik1i8c69.cloudfront.net/w.js';
        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(wa, s);
        })();
      </script>
<link rel="canonical" href="https://ignite.apache.org/releases/latest/dotnetdoc/api/Apache.Ignite.Core.Cache.Configuration.QueryIndex.html" />

    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class QueryIndex
   | Apache Ignite.NET </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class QueryIndex
   | 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.QueryIndex">
  
  
  <h1 id="Apache_Ignite_Core_Cache_Configuration_QueryIndex" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex" class="text-break">Class QueryIndex
  </h1>
  <div class="markdown level0 summary"><p>Represents cache query index configuration.</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">QueryIndex</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_QueryIndex_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class QueryIndex</code></pre>
  </div>
  <h3 id="constructors">Constructors
  </h3>
  <a id="Apache_Ignite_Core_Cache_Configuration_QueryIndex__ctor_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.#ctor*"></a>
  <h4 id="Apache_Ignite_Core_Cache_Configuration_QueryIndex__ctor" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.#ctor">QueryIndex()</h4>
  <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryIndex.html">QueryIndex</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 QueryIndex()</code></pre>
  </div>
  <a id="Apache_Ignite_Core_Cache_Configuration_QueryIndex__ctor_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.#ctor*"></a>
  <h4 id="Apache_Ignite_Core_Cache_Configuration_QueryIndex__ctor_Apache_Ignite_Core_Cache_Configuration_QueryIndexField___" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.#ctor(Apache.Ignite.Core.Cache.Configuration.QueryIndexField[])">QueryIndex(QueryIndexField[])</h4>
  <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryIndex.html">QueryIndex</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 QueryIndex(params QueryIndexField[] fields)</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.Core.Cache.Configuration.QueryIndexField.html">QueryIndexField</a>[]</td>
        <td><span class="parametername">fields</span></td>
        <td><p>The fields.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="Apache_Ignite_Core_Cache_Configuration_QueryIndex__ctor_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.#ctor*"></a>
  <h4 id="Apache_Ignite_Core_Cache_Configuration_QueryIndex__ctor_System_Boolean_Apache_Ignite_Core_Cache_Configuration_QueryIndexType_System_String___" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.#ctor(System.Boolean,Apache.Ignite.Core.Cache.Configuration.QueryIndexType,System.String[])">QueryIndex(Boolean, QueryIndexType, String[])</h4>
  <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryIndex.html">QueryIndex</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 QueryIndex(bool isDescending, QueryIndexType indexType, params string[] fieldNames)</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.Boolean</span></td>
        <td><span class="parametername">isDescending</span></td>
        <td><p>Sort direction.</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryIndexType.html">QueryIndexType</a></td>
        <td><span class="parametername">indexType</span></td>
        <td><p>Type of the index.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.String</span>[]</td>
        <td><span class="parametername">fieldNames</span></td>
        <td><p>Names of the fields to index.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="Apache_Ignite_Core_Cache_Configuration_QueryIndex__ctor_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.#ctor*"></a>
  <h4 id="Apache_Ignite_Core_Cache_Configuration_QueryIndex__ctor_System_Boolean_System_String___" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.#ctor(System.Boolean,System.String[])">QueryIndex(Boolean, String[])</h4>
  <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryIndex.html">QueryIndex</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 QueryIndex(bool isDescending, params string[] fieldNames)</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.Boolean</span></td>
        <td><span class="parametername">isDescending</span></td>
        <td><p>Sort direction.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.String</span>[]</td>
        <td><span class="parametername">fieldNames</span></td>
        <td><p>Names of the fields to index.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="Apache_Ignite_Core_Cache_Configuration_QueryIndex__ctor_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.#ctor*"></a>
  <h4 id="Apache_Ignite_Core_Cache_Configuration_QueryIndex__ctor_System_String___" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.#ctor(System.String[])">QueryIndex(String[])</h4>
  <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryIndex.html">QueryIndex</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 QueryIndex(params string[] fieldNames)</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.String</span>[]</td>
        <td><span class="parametername">fieldNames</span></td>
        <td><p>Names of the fields to index.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="fields">Fields
  </h3>
  <h4 id="Apache_Ignite_Core_Cache_Configuration_QueryIndex_DefaultInlineSize" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.DefaultInlineSize">DefaultInlineSize</h4>
  <div class="markdown level1 summary"><p>Default value for <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryIndex.html#Apache_Ignite_Core_Cache_Configuration_QueryIndex_InlineSize">InlineSize</a>.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public const int DefaultInlineSize = -1</code></pre>
  </div>
  <h5 class="fieldValue">Field 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.Int32</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
  </h3>
  <a id="Apache_Ignite_Core_Cache_Configuration_QueryIndex_Fields_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.Fields*"></a>
  <h4 id="Apache_Ignite_Core_Cache_Configuration_QueryIndex_Fields" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.Fields">Fields</h4>
  <div class="markdown level1 summary"><p>Gets or sets a collection of fields to be indexed.</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;QueryIndexField&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.QueryIndexField.html">QueryIndexField</a>&gt;</td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <a id="Apache_Ignite_Core_Cache_Configuration_QueryIndex_IndexType_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.IndexType*"></a>
  <h4 id="Apache_Ignite_Core_Cache_Configuration_QueryIndex_IndexType" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.IndexType">IndexType</h4>
  <div class="markdown level1 summary"><p>Gets or sets the type of the index.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public QueryIndexType IndexType { 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><a class="xref" href="Apache.Ignite.Core.Cache.Configuration.QueryIndexType.html">QueryIndexType</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <a id="Apache_Ignite_Core_Cache_Configuration_QueryIndex_InlineSize_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.InlineSize*"></a>
  <h4 id="Apache_Ignite_Core_Cache_Configuration_QueryIndex_InlineSize" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.InlineSize">InlineSize</h4>
  <div class="markdown level1 summary"><p>Gets index inline size in bytes. When enabled part of indexed value will be placed directly to index pages,
thus minimizing data page accesses and increasing query performance.
<p>
Allowed values:
<ul>
<li><code>-1</code> (default) - determine inline size automatically(see below)</li>
<li><code>0</code> - index inline is disabled(not recommended)</li>
<li>positive value - fixed index inline</li>
</ul>
When set to <code>-1</code>, Ignite will try to detect inline size automatically. It will be no more than
<a class="xref" href="Apache.Ignite.Core.Cache.Configuration.CacheConfiguration.html#Apache_Ignite_Core_Cache_Configuration_CacheConfiguration_SqlIndexMaxInlineSize">SqlIndexMaxInlineSize</a>.
Index inline will be enabled for all fixed-length types,
 but <strong>will not be enabled</strong> for <span class="xref">System.String</span>.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public int InlineSize { 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.Int32</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <a id="Apache_Ignite_Core_Cache_Configuration_QueryIndex_Name_" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.Name*"></a>
  <h4 id="Apache_Ignite_Core_Cache_Configuration_QueryIndex_Name" data-uid="Apache.Ignite.Core.Cache.Configuration.QueryIndex.Name">Name</h4>
  <div class="markdown level1 summary"><p>Gets or sets the index name.
Will be set automatically if not specified.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string Name { 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 - 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>