Skip to main content
Version: 3.7.0

OdataRequestStrategy

Defined in: src/lib/strategies/odata-request.strategy.ts:41

Request strategy for the OData v4 driver

Generates URIs using OData's system query options:

  • Filters: a single $filter= parameter holding and-joined terms in OData's expression language (Price gt 20 and Category eq 'Electronics')
  • Operator filters: translated from FilterOperatorEnum — see the mapping on _formatOperatorTerms
  • Sorts: $orderby=field asc,other desc (CSV with explicit direction)
  • Select: $select=col1,col2
  • Expand: $expand=rel,other($select=col1,col2) — plain relations come from addIncludes, column-projected ones from addEmbedded
  • Search: $search=term (OData v4 free-text search)
  • Pagination: $top=N&$skip=M (skip derived from state.page) plus a constant $count=true so responses carry the @odata.count total the response strategy needs

The $-prefixed parameter names are fixed by the OData specification and intentionally not configurable through QueryBuilderOptions; they live as private statics so they are visible in one place. String literals are single-quoted with embedded quotes doubled ('O''Brien') per the OData ABNF; numbers and booleans are emitted bare.

PostgREST-native full-text search operators (FTS, PHFTS, PLFTS, WFTS) throw UnsupportedFilterOperatorError — use $search or the CONTAINS / ILIKE operator filters instead.

See​

Extends​

  • AbstractRequestStrategy

Constructors​

Constructor​

new OdataRequestStrategy(): OdataRequestStrategy

Returns​

OdataRequestStrategy

Inherited from​

AbstractRequestStrategy.constructor

Properties​

capabilities​

readonly capabilities: IStrategyCapabilities

Defined in: src/lib/strategies/odata-request.strategy.ts:48

Filters, operator filters, sorts, flat select, includes and embedded (both folding into $expand), global search — no per-model fields (OData has no JSON:API-style fields[type] projection)

Overrides​

AbstractRequestStrategy.capabilities

Methods​

assertResource()​

protected assertResource(state): void

Defined in: src/lib/strategies/abstract-request.strategy.ts:89

Throw if the resource is not set on the state

Centralises the message that was previously copy-pasted across four of the five concrete strategies.

Parameters​

state​

IQueryBuilderState

The current query builder state

Returns​

void

Throws​

Error if state.resource is empty

Inherited from​

AbstractRequestStrategy.assertResource

baseUri()​

protected baseUri(state): string

Defined in: src/lib/strategies/abstract-request.strategy.ts:101

Compute the base path (no query string)

Parameters​

state​

IQueryBuilderState

The current query builder state

Returns​

string

The base URI without the query separator (e.g. /users or https://api.example.com/users)

Inherited from​

AbstractRequestStrategy.baseUri

buildUri()​

buildUri(state, options): string

Defined in: src/lib/strategies/abstract-request.strategy.ts:42

Compose the full request URI from the given state

Template method: validates the resource, computes the base path, delegates the per-driver query-string segments to parts(...), and joins them with the conventional ?/& separators.

Parameters​

state​

IQueryBuilderState

The current query builder state

options​

QueryBuilderOptions

The query parameter key name configuration

Returns​

string

The composed URI string

Throws​

Error if the resource is not set

Inherited from​

AbstractRequestStrategy.buildUri

join()​

protected join(base, segments): string

Defined in: src/lib/strategies/abstract-request.strategy.ts:115

Glue the base URI and the per-driver query-string segments

Returns the bare base when no segments were emitted (e.g. PostgREST in RANGE mode with no filters), otherwise joins with ? + &.

Parameters​

base​

string

The base URI from _baseUri

segments​

string[]

The query-string fragments from parts(...)

Returns​

string

The full URI

Inherited from​

AbstractRequestStrategy.join

parts()​

protected parts(state, _options): string[]

Defined in: src/lib/strategies/odata-request.strategy.ts:84

Emit OData-format query-string segments in canonical order: $filter → $orderby → $select → $expand → $search → $count → $top → $skip

Parameters​

state​

IQueryBuilderState

The current query builder state

_options​

QueryBuilderOptions

The query parameter key name configuration (unused — every OData system query option name is fixed by the specification)

Returns​

string[]

Ordered query-string fragments

Overrides​

AbstractRequestStrategy.parts

validateLimit()​

validateLimit(limit): void

Defined in: src/lib/strategies/abstract-request.strategy.ts:59

Validate that a limit value is acceptable for this driver

Default policy: positive integer. Drivers that recognise a sentinel (NestJS treats -1 as "fetch all") override this method.

Parameters​

limit​

number

The limit value to validate

Returns​

void

Throws​

If the value is not a positive integer

Inherited from​

AbstractRequestStrategy.validateLimit