Microsoft.AspNet.OData.Query Namespace

Classes

ApplyQueryOption

This defines a $apply OData query option for querying.

CountAttribute

Represents an Attribute that can be placed on a class or property correlate to OData's $count query option settings.

CountQueryOption

Represents the value of the $count query option and exposes a way to retrieve the number of entities that satisfy a query.

DefaultQuerySettings

This class describes the default settings to use during query composition.

DefaultSkipTokenHandler

Default implementation of SkipTokenHandler for the service.

ExpandAttribute

Represents an Attribute that can be placed on a property or a class correlate to OData's $expand query option settings.

ExpandConfiguration

Represents a configuration of an expandable property.

FilterAttribute

Represents an Attribute that can be placed on a class or property correlate to OData's $filter query option settings.

FilterQueryOption

This defines a $filter OData query option for querying.

ModelBoundQuerySettings

This class describes the model bound settings to use during query composition.

NonFilterableAttribute

Represents an Attribute that can be placed on a property to specify that the property cannot be used in the $filter OData query option.

NotCountableAttribute

Represents an Attribute that can be placed on a property to specify that the $count cannot be applied on the property.

NotExpandableAttribute

Represents an Attribute that can be placed on a property to specify that the property cannot be used in the $expand OData query option.

NotFilterableAttribute

Represents an Attribute that can be placed on a property to specify that the property cannot be used in the $filter OData query option.

NotNavigableAttribute

Represents an Attribute that can be placed on a property to specify that the property cannot be navigated in OData query.

NotSortableAttribute

Represents an Attribute that can be placed on a property to specify that the property cannot be used in the $orderby OData query option.

ODataQueryOptions

This defines a composite OData query options that can be used to perform query composition. Currently this only supports $filter, $orderby, $top, $skip, and $count.

ODataQueryOptions<TEntity>

This defines a composite OData query options that can be used to perform query composition. Currently this only supports $filter, $orderby, $top, $skip.

ODataQueryOptionsParserFactory

Factory for IODataQueryOptionsParser classes to handle parsing of OData query options in the request body.

ODataQuerySettings

This class describes the settings to use during query composition.

ODataRawQueryOptions

Represents the raw query values in the string format from the incoming request.

ODataValidationSettings

This class describes the validation settings for querying.

OrderByAttribute

Represents an Attribute that can be placed on a class or property correlate to OData's $orderby query option settings.

OrderByCountNode

Represents an order by IEdmProperty expression.

OrderByItNode

Represents the order by expression '$it' in the $orderby clause.

OrderByNode

Represents a single order by expression in the $orderby clause.

OrderByOpenPropertyNode

Represents ordering on a dynamic property

OrderByPropertyNode

Represents an order by IEdmProperty expression.

OrderByQueryOption

This defines a $orderby OData query option for querying.

PageAttribute

Represents an Attribute that can be placed on a property or a class to specify that the maximum value of $top and query result return number of that property or type.

ParameterAliasNodeTranslator

This defines a translator to translate parameter alias nodes.

PlainTextODataQueryOptionsParser

Reads and parses the content of a Stream into a query options part of an OData URL. The query options are passed in the request body as plain text.

QueryFilterProvider

An implementation of System.Web.Http.Filters.IFilterProvider that applies an action filter to any action with an IQueryable or IQueryable<T> return type that doesn't bind a parameter of type ODataQueryOptions.

SelectAttribute

Represents an Attribute that can be placed on a property or a class correlate to OData's $select query option settings.

SelectExpandQueryOption

Represents the OData $select and $expand query options.

SkipQueryOption

This defines a $skip OData query option for querying.

SkipTokenHandler

Represents how NextLink for paging is generated.

SkipTokenQueryOption

This defines a $skiptoken OData query option for querying.

TopQueryOption

This defines a $top OData query option for querying.

TruncatedCollection<T>

Represents a class that truncates a collection to a given page size.

UnsortableAttribute

Represents an Attribute that can be placed on a property to specify that the property cannot be used in the $orderby OData query option.

Interfaces

IODataQueryOptionsParser

Exposes the ability to read and parse the content of a Stream into a query options part of an OData URL. Query options may be passed in the request body to a resource path ending in /$query.

IPropertyMapper

The result of a $select and $expand projection is represented as an ISelectExpandWrapper instance. That instance can be projected into an IDictionary<TKey,TValue> instance by calling ToDictionary(Func<IEdmModel,IEdmStructuredType,IPropertyMapper>). That method will use the function to construct an IPropertyMapper that will map the property names in that projection to the keys in the returned IDictionary<TKey,TValue>. The main purpose of converting an ISelectExpandWrapper instance into an IDictionary<TKey,TValue> (using the method mentioned above) is to allow changing the names of the properties in the IEdmStructuredType that will be used during the serialization of the $select and $expand projection by a given formatter. For example, to support custom serialization attributes of a particular formatter.

ISelectExpandWrapper

Represents the result of a $select and $expand query operation.

ITruncatedCollection

Represents a collection that is truncated to a given page size.

Enums

AllowedArithmeticOperators

Arithmetic operators to allow for querying using $filter.

AllowedFunctions

Functions to allow for querying using $filter.

AllowedLogicalOperators

Logical operators to allow for querying using $filter.

AllowedQueryOptions

OData query options to allow for querying.

HandleNullPropagationOption

This enum defines how to handle null propagation in queryable support.

QueryOptionSetting

Represents the setting of a query option.

SelectExpandType

Represents the type of expand and select.