DataSourceApiQuery Class

Represents the ActualData Object query which is performed on Casewhere DataSource.

Inheritance Hierarchy

SystemObject
Casewhere.Runtime.DSL.ApiDataApiQuery
Casewhere.Runtime.DSL.ApiDataSourceApiQuery

Namespace: Casewhere.Runtime.DSL.Api
Assembly: Casewhere.Runtime (in Casewhere.Runtime.dll) Version: 2.8.5.0

Syntax

Copy

public class DataSourceApiQuery : DataApiQuery

The DataSourceApiQuery type exposes the following members.

Properties

	Name	Description
	CustomCollation	This parameter specifies the custom collation for the query. (Inherited from DataApiQuery)
	DataSourceName	The ActualData Source name.
	DataSourceParameters	The Parameters that passed to the data source query.
	Filter	The filter object that is built using FilterBuilder. (Inherited from DataApiQuery)
	GeoSpatialStages	(Inherited from DataApiQuery)
	HintIndexForCount	The hint index name specified for the counting query. (Inherited from DataApiQuery)
	HintIndexName	The hint index name specified for the query. (Inherited from DataApiQuery)
	IncludeTotal	Determines whether Casewhere returns the total number of ActualData Objects. (Inherited from DataApiQuery)
	MaxQueryTimeout	The max timeout specified for the query. (Inherited from DataApiQuery)
	ProjectedFields	The list of fields returned to Client. By default, Casewhere will return all. (Inherited from DataApiQuery)
	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. (Inherited from DataApiQuery)
	Skip	Bypasses a specified number of elements in a sequence and then returns the remaining elements. By default, Casewhere will skip none. (Inherited from DataApiQuery)
	SortedFields	List of sort fields. (Inherited from DataApiQuery)
	Take	Determines the number of ActualData Objects returned. By default, Casewhere will take all. (Inherited from DataApiQuery)

Top

Methods

	Name	Description
	FilterBy(DynamicFilter)	Set query filter. For chaining purpose.
	FilterBy(Object)	Set query filter. For chaining purpose.
	For	Creates the query object.
	GeoNear	Create a geospatial queries that find documents near a specific location, taking distance constraints into account.
	GeoNearSphere	Create a geospatial query for finding documents near a specific geographic location, emphasizing spherical calculations.
	IncludeTotalItems	Determines whether Casewhere returns the total number of ActualData Objects. For chaining purpose.
	Near	Create a geospatial queries that find documents near a specific location, taking distance constraints into account.
	NearSphere	Create a geospatial query for finding documents near a specific geographic location, emphasizing spherical calculations.
	OrderBy	Set query sorting. For chaining purpose.
	Paging	Set query paging. For chaining purpose.
	ProjectOn	Set query projection. For chaining purpose.
	SetHintIndex	Specify a hint index name for this query.
	SetHintIndexForCount	Specify a hint index name for this counting query.
	SetMaxQueryTimeout	Specify max timeout for this query.
	SetParameter	Add a parameter into the parameters of the query.
	SetParameters	Set parameters for the query.
	ToRuntimeQuery	Convert DataSourceApiQuery to PagedDataSourceQuery. Ensure ProjectedFields has Id.
	WithCustomCollation	Specify a custom collation for this query. If not specified, the data source's collation will be used, if not specified too, the default collation will be used.

Top

Example

Copy

var filter = FilterBuilder.Create().Eq("DepartmentId", ctx.Input.Id).Eq("Active", true).Build();
var query = DataSourceApiQuery.For("EmployeeWithDepartments")
    .FilterBy(filter)
    .ProjectOn("Username", "Department")
    .OrderBy("Firstname", true)
    .Paging(0, 10);
var result = ctx.Use<IDataApi>().Search(query);

Reference

Casewhere.Runtime.DSL.Api Namespace