PostgrestRequestStrategy
ArchivedThese are the docs for ng-qubee 3.8. Read the 4.0 docs for @qubeejs/angular.
Defined in: src/lib/strategies/postgrest-request.strategy.ts:31
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.
Extends
Section titled “Extends”AbstractRequestStrategy
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PostgrestRequestStrategy(
paginationMode?):PostgrestRequestStrategy
Defined in: src/lib/strategies/postgrest-request.strategy.ts:66
Parameters
Section titled “Parameters”paginationMode?
Section titled “paginationMode?”PaginationModeEnum = PaginationModeEnum.QUERY
Wire-level pagination mechanism. Defaults to
PaginationModeEnum.QUERY; provideNgQubee wires this from
IConfig.pagination.
Returns
Section titled “Returns”PostgrestRequestStrategy
Overrides
Section titled “Overrides”AbstractRequestStrategy.constructor
Properties
Section titled “Properties”capabilities
Section titled “capabilities”
readonlycapabilities:IStrategyCapabilities
Defined in: src/lib/strategies/postgrest-request.strategy.ts:38
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)
Overrides
Section titled “Overrides”AbstractRequestStrategy.capabilities
Methods
Section titled “Methods”assertResource()
Section titled “assertResource()”
protectedassertResource(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
Section titled “Parameters”The current query builder state
Returns
Section titled “Returns”void
Throws
Section titled “Throws”Error if state.resource is empty
Inherited from
Section titled “Inherited from”AbstractRequestStrategy.assertResource
baseUri()
Section titled “baseUri()”
protectedbaseUri(state):string
Defined in: src/lib/strategies/abstract-request.strategy.ts:101
Compute the base path (no query string)
Parameters
Section titled “Parameters”The current query builder state
Returns
Section titled “Returns”string
The base URI without the query separator (e.g. /users or https://api.example.com/users)
Inherited from
Section titled “Inherited from”AbstractRequestStrategy.baseUri
buildPaginationHeaders()
Section titled “buildPaginationHeaders()”buildPaginationHeaders(
state):Record<string,string> |null
Defined in: src/lib/strategies/postgrest-request.strategy.ts:83
Compute 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.
Parameters
Section titled “Parameters”The current query builder state
Returns
Section titled “Returns”Record<string, string> | null
{ 'Range-Unit': 'items', 'Range': 'from-to' } or null
buildUri()
Section titled “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
Section titled “Parameters”The current query builder state
options
Section titled “options”The query parameter key name configuration
Returns
Section titled “Returns”string
The composed URI string
Throws
Section titled “Throws”Error if the resource is not set
Inherited from
Section titled “Inherited from”AbstractRequestStrategy.buildUri
join()
Section titled “join()”
protectedjoin(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
Section titled “Parameters”string
The base URI from _baseUri
segments
Section titled “segments”string[]
The query-string fragments from parts(...)
Returns
Section titled “Returns”string
The full URI
Inherited from
Section titled “Inherited from”AbstractRequestStrategy.join
parts()
Section titled “parts()”
protectedparts(state,options):string[]
Defined in: src/lib/strategies/postgrest-request.strategy.ts:108
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)
Parameters
Section titled “Parameters”The current query builder state
options
Section titled “options”The query parameter key name configuration
Returns
Section titled “Returns”string[]
Ordered query-string fragments
Overrides
Section titled “Overrides”AbstractRequestStrategy.parts
validateLimit()
Section titled “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
Section titled “Parameters”number
The limit value to validate
Returns
Section titled “Returns”void
Throws
Section titled “Throws”If the value is not a positive integer
Inherited from
Section titled “Inherited from”AbstractRequestStrategy.validateLimit