API/OdataRequestStrategy

OdataRequestStrategy

src/strategies/odata-request.strategy.ts6 public methodsclass

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.

Constructor

new OdataRequestStrategy()

Properties

Property	Type	Description
`capabilities`	`StrategyCapabilities`	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)

Methods

assertResource()

assertResource(state: QueryBuilderState): void

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.

Parameter	Type	Description
`state`	`QueryBuilderState`	The current query builder state

baseUri()

baseUri(state: QueryBuilderState): string

Compute the base path (no query string)

Parameter	Type	Description
`state`	`QueryBuilderState`	The current query builder state

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

buildUri()

buildUri(state: QueryBuilderState, options: QueryBuilderOptions): string

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.

Parameter	Type	Description
`state`	`QueryBuilderState`	The current query builder state
`options`	`QueryBuilderOptions`	The query parameter key name configuration

Returns — The composed URI string

join()

join(base: string, segments: string[]): string

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 ? + &.

Parameter	Type	Description
`base`	`string`	The base URI from `_baseUri`
`segments`	`string[]`	The query-string fragments from `parts(...)`

Returns — The full URI

parts()

parts(state: QueryBuilderState, _options: QueryBuilderOptions): string[]

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

Parameter	Type	Description
`state`	`QueryBuilderState`	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 — Ordered query-string fragments

validateLimit()

validateLimit(limit: number): void

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.

Parameter	Type	Description
`limit`	`number`	The limit value to validate