Class QueryIndex

Represents cache query index configuration.

Inheritance
object
QueryIndex
Inherited Members
Namespace: Apache.Ignite.Core.Cache.Configuration
Assembly: Apache.Ignite.Core.dll
Syntax
public class QueryIndex

Constructors

QueryIndex()

Initializes a new instance of the QueryIndex class.

Declaration
public QueryIndex()

QueryIndex(params QueryIndexField[])

Initializes a new instance of the QueryIndex class.

Declaration
public QueryIndex(params QueryIndexField[] fields)
Parameters
Type Name Description
QueryIndexField[] fields

The fields.

QueryIndex(bool, QueryIndexType, params string[])

Initializes a new instance of the QueryIndex class.

Declaration
public QueryIndex(bool isDescending, QueryIndexType indexType, params string[] fieldNames)
Parameters
Type Name Description
bool isDescending

Sort direction.
QueryIndexType indexType

Type of the index.
string[] fieldNames

Names of the fields to index.

QueryIndex(bool, params string[])

Initializes a new instance of the QueryIndex class.

Declaration
public QueryIndex(bool isDescending, params string[] fieldNames)
Parameters
Type Name Description
bool isDescending

Sort direction.
string[] fieldNames

Names of the fields to index.

QueryIndex(params string[])

Initializes a new instance of the QueryIndex class.

Declaration
public QueryIndex(params string[] fieldNames)
Parameters
Type Name Description
string[] fieldNames

Names of the fields to index.

Fields

DefaultInlineSize

Default value for InlineSize.

Declaration
public const int DefaultInlineSize = -1
Field Value
Type Description
int

Properties

Fields

Gets or sets a collection of fields to be indexed.

Declaration
[SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
public ICollection<QueryIndexField> Fields { get; set; }
Property Value
Type Description
ICollection<QueryIndexField>

IndexType

Gets or sets the type of the index.

Declaration
public QueryIndexType IndexType { get; set; }
Property Value
Type Description
QueryIndexType

InlineSize

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.

Allowed values:
  • -1 (default) - determine inline size automatically(see below)
  • 0 - index inline is disabled(not recommended)
  • positive value - fixed index inline
When set to -1, Ignite will try to detect inline size automatically. It will be no more than SqlIndexMaxInlineSize. Index inline will be enabled for all fixed-length types, but will not be enabled for string.
Declaration
public int InlineSize { get; set; }
Property Value
Type Description
int

Name

Gets or sets the index name. Will be set automatically if not specified.

Declaration
public string Name { get; set; }
Property Value
Type Description
string