DataQueryOperation
Namespace: Meshmakers.Octo.Runtime.Contracts.Repositories.Query
Represents a data query operation.
public class DataQueryOperation : FieldFilterCriteria
Inheritance Object → FieldFilterCriteria → DataQueryOperation
Properties
Language
The language to use for text search. This text has to be the two-letter ISO language name.
public string Language { get; private set; }
Property Value
TextSearchFilter
Represents full text search function for configured attributes (dependent of data source type)
public TextSearchFilter TextSearchFilter { get; private set; }
Property Value
AttributeSearchFilter
Represents text search function for specific attributes.
public AttributeSearchFilter AttributeSearchFilter { get; private set; }
Property Value
FieldGroupBy
Represents field group by for specific attributes.
public FieldGroupBy FieldGroupBy { get; private set; }
Property Value
SortOrders
Represents sort order for specific attributes.
public ICollection<SortOrderItem> SortOrders { get; private set; }
Property Value
GeospatialFilters
Represents geospatial filter for specific attributes.
public ICollection<GeospatialFilter> GeospatialFilters { get; internal set; }
Property Value
FieldFilters
Represents field filters for specific attributes with different comparison operators.
public ICollection<FieldFilter> FieldFilters { get; internal set; }
Property Value
Methods
Create(String)
Creates a new instance of DataQueryOperation.
public static DataQueryOperation Create(string language)
Parameters
language String
The language to use for text search. This text has to be the two letter ISO language name.
Returns
UseLanguage(String)
Uses the given language for text search.
public DataQueryOperation UseLanguage(string language)
Parameters
language String
The language to use for text search. This text has to be the two letter ISO language name.
Returns
SortOrder(String, SortOrders)
Adds a sort order to the query.
public DataQueryOperation SortOrder(string attributeName, SortOrders sortOrder)
Parameters
attributeName String
Attribute name
sortOrder SortOrders
Sort order
Returns
TextSearch(Object)
Sets the text search filter.
public DataQueryOperation TextSearch(object searchTerm)
Parameters
searchTerm Object
Search term for full text search.
Returns
AttributeSearch(IEnumerable<String>, Object)
Sets the attribute search filter.
public DataQueryOperation AttributeSearch(IEnumerable<string> attributeNames, object searchTerm)
Parameters
attributeNames IEnumerable<String>
List of attribute names for full text search
searchTerm Object
Search term for full text search.
Returns
GroupBy(String[])
Groups by the given attribute names.
public FieldGroupBy GroupBy(String[] attributeNames)
Parameters
attributeNames String[]
Attribute names to group by.
Returns
NearGeospatialFilter(String, Point, Nullable<Double>, Nullable<Double>)
Adds a field filter to the query.
public DataQueryOperation NearGeospatialFilter(string attributeName, Point point, Nullable<double> minDistance, Nullable<double> maxDistance)
Parameters
attributeName String
Name of attribute
point Point
Point to search for
minDistance Nullable<Double>
The minimum distance from the center point that the documents can be.
maxDistance Nullable<Double>
The maximum distance from the center point that the documents can be.