Class ODataQuerySettings

Namespace

System.Web.Http.OData.Query

Assembly

System.Web.Http.OData.dll

This class describes the settings to use during query composition.

public class ODataQuerySettings

Inheritance

object

ODataQuerySettings

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ODataQuerySettings()

Instantiates a new instance of the ODataQuerySettings class and initializes the default settings.

public ODataQuerySettings()

ODataQuerySettings(ODataQuerySettings)

Initialize a new instance of the ODataQuerySettings class based on an existing one.

public ODataQuerySettings(ODataQuerySettings settings)

Parameters

settings ODataQuerySettings

The setting to copy from.

Properties

EnableConstantParameterization

Gets or sets a value indicating whether constants should be parameterized. Parameterizing constants would result in better performance with Entity framework.

public bool EnableConstantParameterization { get; set; }

Property Value

bool

The default value is true.

EnsureStableOrdering

Gets or sets a value indicating whether query composition should alter the original query when necessary to ensure a stable sort order.

public bool EnsureStableOrdering { get; set; }

Property Value

bool

A true value indicates the original query should be modified when necessary to guarantee a stable sort order. A false value indicates the sort order can be considered stable without modifying the query. Query providers that ensure a stable sort order should set this value to false. The default value is true.

HandleNullPropagation

Gets or sets a value indicating how null propagation should be handled during query composition.

public HandleNullPropagationOption HandleNullPropagation { get; set; }

Property Value

HandleNullPropagationOption

The default is Default.

PageSize

Gets or sets the maximum number of query results to return.

public int? PageSize { get; set; }

Property Value

int?

The maximum number of query results to return, or null if there is no limit.