Class RVElasticsearchDataSourceItem

Elasticsearch data source item

Inheritance
System.Object
RVElasticsearchDataSourceItem
Implements
Namespace: Reveal.Sdk.Data.Elasticsearch
Assembly: Infragistics.Reveal.Connectors.Elasticsearch.dll
Syntax
public class RVElasticsearchDataSourceItem : RVDataSourceItem, IDataSourceItem, IProcessDataOnServerDataSourceItem, IParameterizedCustomQuerySupport, ICustomQuerySupport

Constructors

RVElasticsearchDataSourceItem(RVElasticsearchDataSource)

Declaration
public RVElasticsearchDataSourceItem(RVElasticsearchDataSource dataSource)
Parameters
Type Name Description
RVElasticsearchDataSource dataSource

Properties

CustomQuery

(Optional) Custom Elasticsearch SQL query to execute instead of using the default index query.

Declaration
public string CustomQuery { get; set; }
Property Value
Type Description
System.String

CustomQueryParameters

(Optional) Parameters to be used in the custom SQL query, if any. The parameters are expected to be named parameters in the query, like @param1, @param2, etc.

Declaration
public Dictionary<string, object> CustomQueryParameters { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.Object>

FieldMultiValueLeniency

(Optional) Controls behavior when SQL queries encounter fields with multiple values. If false, an error is returned for fields containing array values. If true, returns the first value from the array with no guarantee of consistent ordering. Defaults to false.

Declaration
public Nullable<bool> FieldMultiValueLeniency { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Index

The name of the Elasticsearch index to query.

Declaration
public string Index { get; set; }
Property Value
Type Description
System.String

ProcessDataOnServer

Returns whether data processing is performed on the Reveal server.

Declaration
public bool ProcessDataOnServer { get; set; }
Property Value
Type Description
System.Boolean

Methods

CreateModelDataSourceItem()

Declaration
public override BaseDataSourceItem CreateModelDataSourceItem()
Returns
Type Description
Infragistics.ReportPlus.DashboardModel.BaseDataSourceItem
Overrides
RVDataSourceItem.CreateModelDataSourceItem()

Implements

IProcessDataOnServerDataSourceItem
IParameterizedCustomQuerySupport
ICustomQuerySupport