Click or drag to resize

DataSourceEnumerationQuery Class
The DataSourceEnumerationQuery contains Filter, ProjectedFields, SortedFields, DataSourceName, BatchSize data. These info used to build query directly to database. The one create by a static method DataSourceEnumerationQuery.For().
Inheritance Hierarchy
SystemObject
  Casewhere.Runtime.DSL.ApiDataSourceEnumerationQuery

Namespace: Casewhere.Runtime.DSL.Api
Assembly: Casewhere.Runtime (in Casewhere.Runtime.dll) Version: 2.8.5.0
Syntax
C#
Copy
public class DataSourceEnumerationQuery

The DataSourceEnumerationQuery type exposes the following members.

Properties
 NameDescription
Public propertyBatchSize Amount documents per batch. The default value is 100.
Public propertyCustomCollation This parameter specifies the custom collation for the query.
Public propertyDataSourceName The name of the data source
Public propertyFilter The filter object that is built using FilterBuilder.
Public propertyGeoSpatialStages 
Public propertyHintIndexName The hint index name specified for the query.
Public propertyProjectedFields The list of fields returned to Client. By default, Casewhere will return all.
Public propertySortedFields List of sorted fields.
Top
Methods
 NameDescription
Public methodFilterBy(DynamicFilter) Set query filter. For chaining purpose.
Public methodFilterBy(Object) Set query filter. For chaining purpose.
Public methodStatic memberFor The static For method use to create a new instance of DataSourceEnumerationQuery type.
Public methodGeoNear Create a geospatial queries that find documents near a specific location, taking distance constraints into account.
Public methodGeoNearSphere Create a geospatial query for finding documents near a specific geographic location, emphasizing spherical calculations.
Public methodNear Create a geospatial queries that find documents near a specific location, taking distance constraints into account.
Public methodNearSphere Create a geospatial query for finding documents near a specific geographic location, emphasizing spherical calculations.
Public methodOrderBy Set query sorting. For chaining purpose.
Public methodProjectOn Set query projection. For chaining purpose.
Public methodSetBatchSize Set batch size to the existing query.
Public methodSetHintIndex Specify a hint index name for this query.
Public methodToEnumerationDataSourceQuery 
Public methodWithCustomCollation 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
C#
Copy
var filter = FilterBuilder.Create().Eq("DepartmentId", ctx.Input.Id).Eq("Active", true).Build();
var query = DataSourceEnumerationQuery.For("Employee")
    .FilterBy(filter)
    .ProjectOn("FirstName", "LastName")
    .OrderBy("FirstName", true);
var result = ctx.Use<IDataApi>().Enumerate(query);
See Also