PostgrestRequestStrategy
Request strategy for the PostgREST driver
PostgREST auto-generates REST APIs from PostgreSQL schemas and is the backbone of Supabase’s data API. This strategy produces URIs in PostgREST’s native query-string format:
- Filters:
col=eq.val(single value) /col=in.(v1,v2,v3)(multi-value) - Order:
order=col1.asc,col2.desc - Select:
select=col1,col2 - Pagination:
limit=N&offset=M(offset derived from state.page)
The order and offset query-parameter names are PostgREST conventions
and are intentionally not configurable via QueryBuilderOptions (see
issue #50 MVP scope). limit, select, and filters (per-column name)
honour the existing option keys.
Constructor
Section titled “Constructor”new PostgrestRequestStrategy(paginationMode: PaginationModeEnum)| Parameter | Type | Description |
|---|---|---|
paginationMode |
PaginationModeEnum |
Wire-level pagination mechanism. Defaults to PaginationModeEnum.QUERY; provideNgQubee wires this from Config.pagination. |
Properties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
capabilities |
StrategyCapabilities |
Filters, operator filters (incl. FTS), sorts, flat select — no per-model fields, no JSON:API/Spatie-style includes, no global search (per-column FTS via the operator family covers it) |
Methods
Section titled “Methods”assertResource()
Section titled “assertResource()”assertResource(state: QueryBuilderState): voidThrow 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()
Section titled “baseUri()”baseUri(state: QueryBuilderState): stringCompute 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)
buildPaginationHeaders()
Section titled “buildPaginationHeaders()”buildPaginationHeaders(state: QueryBuilderState): Record<string, string> | nullCompute Range-Unit / Range HTTP headers for RANGE pagination mode
In QUERY mode this returns null so NgQubeeService.paginationHeaders()
conveys “no headers needed” to the consumer. In RANGE mode the method
converts the 1-indexed state.page + state.limit into PostgREST’s
0-indexed inclusive range (from = (page - 1) * limit,
to = from + limit - 1) and returns both header values.
| Parameter | Type | Description |
|---|---|---|
state |
QueryBuilderState |
The current query builder state |
Returns — { 'Range-Unit': 'items', 'Range': 'from-to' } or null
buildUri()
Section titled “buildUri()”buildUri(state: QueryBuilderState, options: QueryBuilderOptions): stringCompose 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()
Section titled “join()”join(base: string, segments: string[]): stringGlue 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()
Section titled “parts()”parts(state: QueryBuilderState, options: QueryBuilderOptions): string[]Emit PostgREST-format query-string segments in canonical order: filters → operator filters → order → select → (limit + offset in QUERY mode only — RANGE mode passes pagination via headers instead)
| Parameter | Type | Description |
|---|---|---|
state |
QueryBuilderState |
The current query builder state |
options |
QueryBuilderOptions |
The query parameter key name configuration |
Returns — Ordered query-string fragments
validateLimit()
Section titled “validateLimit()”validateLimit(limit: number): voidValidate 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 |