@coasys/ad4m / Exports / ModelQueryBuilder

Class: ModelQueryBuilder<T>

Query builder for Ad4mModel queries. Allows building queries with a fluent interface and either running them once or subscribing to updates.

Example

const builder = Recipe.query(perspective)
  .where({ category: "Dessert" })
  .order({ rating: "DESC" })
  .limit(10);
 
// Run once
const recipes = await builder.run();
 
// Or subscribe to updates
await builder.subscribe(recipes => {
  console.log("Updated recipes:", recipes);
});

Type parameters

Table of contents

Constructors

• constructor

Properties

• ctor
• modelClassName
• perspective
• queryParams

Methods

• collections
• count
• countSubscribe
• get
• limit
• offset
• order
• overrideModelClassName
• paginate
• paginateSubscribe
• properties
• source
• subscribe
• where

Constructors

constructor

• new ModelQueryBuilder<T>(perspective, ctor, query?)

Type parameters

Parameters

Defined in

model/Ad4mModel.ts:882

Properties

ctor

• Private ctor: typeof Ad4mModel

Defined in

model/Ad4mModel.ts:880

modelClassName

• Private modelClassName: string = null

Defined in

model/Ad4mModel.ts:879

perspective

• Private perspective: PerspectiveProxy

Defined in

model/Ad4mModel.ts:877

queryParams

• Private queryParams: Query = {}

Defined in

model/Ad4mModel.ts:878

Methods

collections

▸ collections(collections): ModelQueryBuilder<T>

Specifies which collections to include in the results.

Parameters

Returns

ModelQueryBuilder<T>

The query builder for chaining

Example

.collections(["ingredients", "steps"])

Defined in

model/Ad4mModel.ts:1000

count

▸ count(): Promise<number>

Gets the total count of matching entities.

Returns

Promise<number>

Total count

Example

const totalDesserts = await Recipe.query(perspective)
  .where({ category: "Dessert" })
  .count();

Defined in

model/Ad4mModel.ts:1075

countSubscribe

▸ countSubscribe(callback): Promise<number>

Subscribes to count updates for matching entities.

Parameters

Returns

Promise<number>

Initial count

Example

await Recipe.query(perspective)
  .where({ status: "active" })
  .countSubscribe(count => {
    console.log("Active items:", count);
  });

Defined in

model/Ad4mModel.ts:1096

get

▸ get(): Promise<T[]>

Executes the query once and returns the results.

Returns

Promise<T[]>

Array of matching entities

Example

const recipes = await Recipe.query(perspective)
  .where({ category: "Dessert" })
  .get();

Defined in

model/Ad4mModel.ts:1022

limit

▸ limit(limit): ModelQueryBuilder<T>

Sets the maximum number of results to return.

Parameters

Returns

ModelQueryBuilder<T>

The query builder for chaining

Example

.limit(10)

Defined in

model/Ad4mModel.ts:936

offset

▸ offset(offset): ModelQueryBuilder<T>

Sets the number of results to skip.

Parameters

Returns

ModelQueryBuilder<T>

The query builder for chaining

Example

.offset(20) // Skip first 20 results

Defined in

model/Ad4mModel.ts:952

order

▸ order(orderBy): ModelQueryBuilder<T>

Sets the order for the query results.

Parameters

Returns

ModelQueryBuilder<T>

The query builder for chaining

Example

.order({ createdAt: "DESC" })

Defined in

model/Ad4mModel.ts:920

overrideModelClassName

▸ overrideModelClassName(className): ModelQueryBuilder<T>

Parameters

Returns

ModelQueryBuilder<T>

Defined in

model/Ad4mModel.ts:1005

paginate

▸ paginate(pageSize, pageNumber): Promise<PaginationResult<T>>

Gets a page of results with pagination metadata.

Parameters

Returns

Promise<PaginationResult<T>>

Paginated results with metadata

Example

const page = await Recipe.query(perspective)
  .where({ category: "Main" })
  .paginate(10, 1);
console.log(`Page ${page.pageNumber}, ${page.results.length} of ${page.totalCount}`);

Defined in

model/Ad4mModel.ts:1124

paginateSubscribe

▸ paginateSubscribe(pageSize, pageNumber, callback): Promise<PaginationResult<T>>

Subscribes to paginated results updates.

Parameters

Returns

Promise<PaginationResult<T>>

Initial pagination results

Example

await Recipe.query(perspective)
  .where({ category: "Main" })
  .paginateSubscribe(10, 1, page => {
    console.log("Updated page:", page.results);
  });

Defined in

model/Ad4mModel.ts:1149

properties

▸ properties(properties): ModelQueryBuilder<T>

Specifies which properties to include in the results.

Parameters

Returns

ModelQueryBuilder<T>

The query builder for chaining

Example

.properties(["name", "description", "rating"])

Defined in

model/Ad4mModel.ts:984

source

▸ source(source): ModelQueryBuilder<T>

Sets the source filter for the query.

Parameters

Returns

ModelQueryBuilder<T>

The query builder for chaining

Example

.source("ad4m://self")

Defined in

model/Ad4mModel.ts:968

subscribe

▸ subscribe(callback): Promise<T[]>

Subscribes to the query and receives updates when results change. Also returns initial results immediately.

Parameters

Returns

Promise<T[]>

Initial results array

Example

await Recipe.query(perspective)
  .where({ status: "cooking" })
  .subscribe(recipes => {
    console.log("Currently cooking:", recipes);
  });

Defined in

model/Ad4mModel.ts:1045

where

▸ where(conditions): ModelQueryBuilder<T>

Adds where conditions to the query.

Parameters

Returns

ModelQueryBuilder<T>

The query builder for chaining

Example

.where({
  category: "Dessert",
  rating: { gt: 4 },
  tags: ["vegan", "quick"],
  published: true
})

Defined in

model/Ad4mModel.ts:904