Class DataApiQuery
Namespace: Casewhere.Runtime.DSL.Api
Assembly: Casewhere.Runtime.dll
Represents the data query that is used with Casewhere.Runtime.DSL.Api.IDataApi.
public abstract class DataApiQuery
Inheritance
Derived
DataAuditApiQuery, DataAuditEnumerationQuery, DataObjectApiQuery, DataSourceApiQuery
Inherited Members
object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()
Extension Methods
ObjectExtension.ConvertToBsonValue(object), EnumExtensions.DeepClone<DataApiQuery>(DataApiQuery)
Constructors
DataApiQuery()
protected DataApiQuery()
Properties
CustomCollation
This parameter specifies the custom collation for the query.
public CustomCollation CustomCollation { get; set; }
Property Value
CustomCollation
Filter
The filter object that is built using Casewhere.Runtime.DataObjectExpressions.DSL.FilterBuilder.
public DynamicFilter Filter { get; set; }
Property Value
DynamicFilter
GeoSpatialStages
public IList<BsonDocument> GeoSpatialStages { get; set; }
Property Value
IList<BsonDocument>
HintIndexForCount
The hint index name specified for the counting query.
public string HintIndexForCount { get; set; }
Property Value
HintIndexName
The hint index name specified for the query.
public string HintIndexName { get; set; }
Property Value
IncludeTotal
Determines whether Casewhere returns the total number of ActualData Objects.
public bool IncludeTotal { get; set; }
Property Value
MaxQueryTimeout
The max timeout specified for the query.
public int? MaxQueryTimeout { get; set; }
Property Value
int?
ProjectedFields
The list of fields returned to Client. By default, Casewhere will return all.
public IList<string> ProjectedFields { get; set; }
Property Value
SearchLimit
When the limit is set, Casewhere will only process the search result within that limit, even when more data is found. If the limit is not set, Casewhere will use the SearchLimit configured in the web.config. This limit is applied for full-text search only.
public int? SearchLimit { get; set; }
Property Value
int?
Skip
Bypasses a specified number of elements in a sequence and then returns the remaining elements. By default, Casewhere will skip none.
public int Skip { get; set; }
Property Value
SortedFields
List of sort fields.
public IList<SortField> SortedFields { get; set; }
Property Value
IList<SortField>
Take
Determines the number of ActualData Objects returned. By default, Casewhere will take all.
public int Take { get; set; }