Class Query<T>

A fluent interface for building and executing database queries across all backend adapters. Manages filters, sort orders, and pagination limits dynamically.

Example

const query = new Query(User);
query.where('status', 'active').sortBy('createdAt', 'desc').batch(20);
const results = await query.execute(returnAs.AS_INSTANCES);

Type Parameters

T extends typeof PersistedBaseObject

Index

Constructors

constructor

new Query<T extends typeof PersistedBaseObject>(obj: T, parent?: T): Query<T>
Type Parameters
- T extends typeof PersistedBaseObject
Parameters
- obj: T
- Optionalparent: T
Returns Query<T>
- Defined in packages/backend/src/Query.ts:55

Properties

`Protected`_obj

_obj: T

`Protected`_parent

_parent: T | undefined

filters

filters: Filter[]

Array of instantiated Filter objects defining the query conditions.

limits

limits: Limits

Pagination rules defining limits, batches, and offsets.

sortings

sortings: Sorting[]

Array of Sorting conditions dictating the order of returned results.

Accessors

obj

get obj(): T
Returns T
- Defined in packages/backend/src/Query.ts:64

parent

get parent(): T | undefined
Returns T | undefined
- Defined in packages/backend/src/Query.ts:68
set parent(parent: T | undefined): void
Declare query parent record This may be need in some NoSQL backend to query subcollections
Parameters
- parent: T | undefined
Returns void
- Defined in packages/backend/src/Query.ts:76

sortAndLimit

get sortAndLimit(): SortAndLimit
Returns SortAndLimit
- Defined in packages/backend/src/Query.ts:165

Methods

average

average(property: string, backend?: BackendInterface): Promise<number>
Executes an average aggregation query on the target property.
Parameters
- property: string
  The name of the numeric property to average.
- backend: BackendInterface = ...
  The backend adapter to query against. Defaults to the global default backend.
Returns Promise<number>
A promise resolving to the average of the property values.
- Defined in packages/backend/src/Query.ts:270

batch

batch(batch?: number): Query<T>
Sets the maximum number of records to return (batch size).
Parameters
- batch: number = 10
  The limit of records to fetch. Defaults to 10.
Returns Query<T>
The query instance for chaining.
- Defined in packages/backend/src/Query.ts:160

count

count(backend?: BackendInterface): Promise<number>
Executes a count aggregation query.
Parameters
- backend: BackendInterface = ...
  The backend adapter to query against. Defaults to the global default backend.
Returns Promise<number>
A promise resolving to the count of matching items.
- Defined in packages/backend/src/Query.ts:325

distinct

distinct(property: string, backend?: BackendInterface): Promise<any[]>
Executes a distinct aggregation query on the target property.
Parameters
- property: string
  The name of the property.
- backend: BackendInterface = ...
  The backend adapter to query against. Defaults to the global default backend.
Returns Promise<any[]>
A promise resolving to an array of unique values.
- Defined in packages/backend/src/Query.ts:284

execute

execute(
as?: returnAs,
backend?: BackendInterface,
): Promise<QueryResultType<any>>
Primary execution handler for the query. Transforms the output based on the requested returnAs format.
Parameters
- as: returnAs = returnAs.AS_DATAOBJECTS
  The desired output format (AS_DATAOBJECTS, AS_OBJECTURIS, or AS_INSTANCES).
- backend: BackendInterface = ...
  The backend adapter to query against.
Returns Promise<QueryResultType<any>>
A promise resolving to the query results in the specified format.

Throws
If an unknown output mode is requested.
- Defined in packages/backend/src/Query.ts:225

fetch

fetch(
backend?: BackendInterface,
): Promise<QueryResultType<DataObjectClass<any>>>
Internal: Executes the query against the backend and returns raw DataObjectClass wrappers.
Parameters
- backend: BackendInterface = ...
  The backend adapter to query against. Defaults to the global default backend.
Returns Promise<QueryResultType<DataObjectClass<any>>>
A promise resolving to the raw DataObject results and execution metadata.
- Defined in packages/backend/src/Query.ts:175

fetchAsInstances

fetchAsInstances(backend?: BackendInterface): Promise<QueryResultType<T>>
Executes the query and fully hydrates the results into instances of the target class. This is the standard data retrieval path for applications.
Parameters
- backend: BackendInterface = ...
  The backend adapter to query against.
Returns Promise<QueryResultType<T>>
A promise resolving to an array of fully instantiated model classes.
- Defined in packages/backend/src/Query.ts:203

fetchAsUri

fetchAsUri(backend?: BackendInterface): Promise<QueryResultType<ObjectUri>>
Executes the query and returns only the ObjectUri references of the matching records. Efficient for relational operations where full object hydration is unnecessary.
Parameters
- backend: BackendInterface = ...
  The backend adapter to query against.
Returns Promise<QueryResultType<ObjectUri>>
A promise resolving to an array of URIs.
- Defined in packages/backend/src/Query.ts:188

max

max(property: string, backend?: BackendInterface): Promise<number | undefined>
Executes a maximum aggregation query on the target property.
Parameters
- property: string
  The name of the property.
- backend: BackendInterface = ...
  The backend adapter to query against. Defaults to the global default backend.
Returns Promise<number | undefined>
A promise resolving to the maximum value found, or undefined.
- Defined in packages/backend/src/Query.ts:312

min

min(property: string, backend?: BackendInterface): Promise<number | undefined>
Executes a minimum aggregation query on the target property.
Parameters
- property: string
  The name of the property.
- backend: BackendInterface = ...
  The backend adapter to query against. Defaults to the global default backend.
Returns Promise<number | undefined>
A promise resolving to the minimum value found, or undefined.
- Defined in packages/backend/src/Query.ts:298

offset

offset(offset?: number): Query<T>
Sets the starting offset for pagination.
Parameters
- offset: number = 0
  The number of records to skip before returning results. Defaults to 0.
Returns Query<T>
The query instance for chaining.
- Defined in packages/backend/src/Query.ts:149

setLimits

setLimits(limits: Limits): Query<T>
Directly assigns a preconfigured Limits object for pagination.
Parameters
- limits: Limits
  The Limits pagination configuration.
Returns Query<T>
The query instance for chaining.
- Defined in packages/backend/src/Query.ts:138

setParentName

setParentName(parent: string): void
Updates the parent property of the current object. This method is useful for SQL backends where a model may have two parent records and requires dynamically setting the name of one of them.
Parameters
- parent: string
Returns void
- Defined in packages/backend/src/Query.ts:85

sortBy

sortBy(param: string | Sorting, order?: any): Query<T>
Specifies a sorting rule for the query results.
Parameters
- param: string | Sorting
  The Sorting object or the string name of the field to sort by.
- order: any = 'asc'
  The direction of the sort: 'asc' or 'desc'.
Returns Query<T>
The query instance for chaining.
- Defined in packages/backend/src/Query.ts:122

sum

sum(property: string, backend?: BackendInterface): Promise<number>
Executes a sum aggregation query on the target property.
Parameters
- property: string
  The name of the numeric property to sum.
- backend: BackendInterface = ...
  The backend adapter to query against. Defaults to the global default backend.
Returns Promise<number>
A promise resolving to the sum of the property values.
- Defined in packages/backend/src/Query.ts:256

where

where(param: any, value?: any, operator?: OperatorKeys): Query<T>
Appends a new filter condition to the query. Can accept an instantiated Filter object or raw field parameters.
Parameters
- param: any
  The Filter object or the string name of the field to filter on.
- value: any = null
  The value to match (ignored if param is a Filter).
- operator: OperatorKeys = OperatorKeys.equals
  The OperatorKeys comparison operator (e.g., equals, gt, lt). Defaults to equals.
Returns Query<T>
The query instance for chaining.
- Defined in packages/backend/src/Query.ts:97

Class Query<T>

Example

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Query<T>

Properties

Protected_obj

Protected_parent

filters

limits

meta

sortings

Accessors

obj

Returns T

parent

Returns T | undefined

Parameters

Returns void

sortAndLimit

Returns SortAndLimit

Methods

average

Parameters

Returns Promise<number>

batch

Parameters

Returns Query<T>

count

Parameters

Returns Promise<number>

distinct

Parameters

Returns Promise<any[]>

execute

Parameters

Returns Promise<QueryResultType<any>>

Throws

fetch

Parameters

Returns Promise<QueryResultType<DataObjectClass<any>>>

fetchAsInstances

Parameters

Returns Promise<QueryResultType<T>>

fetchAsUri

Parameters

Returns Promise<QueryResultType<ObjectUri>>

max

Parameters

Returns Promise<number | undefined>

min

Parameters

Returns Promise<number | undefined>

offset

Parameters

Returns Query<T>

setLimits

Parameters

Returns Query<T>

setParentName

Parameters

Returns void

sortBy

Parameters

Returns Query<T>

sum

Parameters

Returns Promise<number>

where

Parameters

Returns Query<T>

Settings

`Protected`_obj

`Protected`_parent