Struct Paging

Namespace

NextORM.Core

Assembly

nextorm.core.dll

Limit/offset pair describing a single page request.

public struct Paging

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

EntityBuilderExtensions.AsEntityBuilder<T>(object?)

Remarks

Was a struct with public mutable fields; the fields are now validated properties so the invariants (non-negative limit/offset) hold. See docs/specs/design/API-NAMING-REVIEW.md findings P1-17 and P2-19.

Properties

HasWithTies

When true, the page request keeps every row tied with the last row by the ORDER BY (FETCH ... WITH TIES / TOP(n) WITH TIES). Requires a dialect that supports it (see SupportsWithTies) and a non-zero Limit.

public bool HasWithTies { readonly get; set; }

Property Value

bool

IsEmpty

true when neither a limit nor an offset is set, so no paging clause is emitted.

public readonly bool IsEmpty { get; }

Property Value

bool

IsTop

true when only a positive limit is set (offset is zero), so the provider can emit a simple TOP/LIMIT without an OFFSET.

public readonly bool IsTop { get; }

Property Value

bool

Limit

Maximum number of rows to return; zero means "no limit".

public int Limit { readonly get; set; }

Property Value

int

Offset

Number of leading rows to skip; zero means "from the start".

public int Offset { readonly get; set; }

Property Value

int