Interface: IQueryTranslator<TQuery>
Defined in: packages/core/src/interfaces/query-translator.interface.ts:13
IQueryTranslator — adapter seam interface for ORM-specific query translation.
Implementations live in adapter packages (e.g., @nestjs-odata/typeorm). The two-method design (translate + execute) separates AST-to-query translation from query execution, enabling independent unit testing of each step.
Generic parameter TQuery is the ORM-specific query type (e.g., TypeORM SelectQueryBuilder).
Type Parameters
TQuery
TQuery = unknown
Methods
execute()
execute(
translatedQuery,includeCount):Promise<ODataQueryResult<unknown>>
Defined in: packages/core/src/interfaces/query-translator.interface.ts:17
Execute the translated query and return structured results
Parameters
translatedQuery
TQuery
includeCount
boolean
Returns
Promise<ODataQueryResult<unknown>>
translate()
translate(
query,entityType):TQuery
Defined in: packages/core/src/interfaces/query-translator.interface.ts:15
Translate a typed OData query AST into an ORM-specific query object
Parameters
query
entityType
Returns
TQuery