Class Model<TData, TVirtual>

constructor

• new Model<
      TData extends JsonObject = JsonObject,
      TVirtual extends JsonObject = JsonObject,
  >(
      data?: Partial<TData & TVirtual>,
      _options?: JsonObject,
  ): Model<TData, TVirtual>

  Type Parameters

  • TData extends JsonObject = JsonObject
  • TVirtual extends JsonObject = JsonObject

  Parameters

  • data: Partial<TData & TVirtual> = {}
  • _options: JsonObject = {}

  Returns Model<TData, TVirtual>

_changed

_data

_isNew

_originalData

Staticdal

Staticoptions

Staticschema

StatictableName

id

• get id(): string

  Returns string

• set id(value: string): void

  Parameters

  • value: string

  Returns void

delete

• delete(): Promise<boolean>

  Returns Promise<boolean>

deleteAllRevisions

• deleteAllRevisions(
      user?: RevisionActor,
      options?: RevisionMetadata,
  ): Promise<any>

  Delete all revisions of this model instance This method will be dynamically assigned by revision handlers

  Parameters

  • user: RevisionActor = null

    User performing the deletion
  • options: RevisionMetadata = {}

    Deletion options

  Returns Promise<any>

  Deletion revision

generateVirtualValues

• generateVirtualValues(): void

  Generate virtual field values

  Returns void

getValue

• getValue(key: any): unknown

  Get property value (data or virtual)

  Parameters

  • key: any

    Property name (camelCase or snake_case)

  Returns unknown

  Property value

newRevision

• newRevision(user?: RevisionActor, options?: RevisionMetadata): Promise<any>

  Parameters

  • user: RevisionActor = null
  • options: RevisionMetadata = {}

  Returns Promise<any>

save

• save(options?: {}): Promise<Model<TData, TVirtual>>

  Save the model instance

  Parameters

  • options: {} = {}

    Save options

  Returns Promise<Model<TData, TVirtual>>

  This instance

saveAll

• saveAll(joinOptions?: {}): Promise<Model<TData, TVirtual>>

  Persist this instance and synchronize any many-to-many relations.

  ⚠️ Only through relations whose join tables contain just foreign keys are managed automatically. If the join table carries additional editable columns (role flags, metadata, timestamps that should be user-controlled, etc.), mutate that table directly instead of relying on saveAll, because the DAL currently treats relation membership as an ID-only diff.

  Parameters

  • joinOptions: {} = {}

    Optional map of relation names to include. When omitted, every declared through relation is synchronized.

  Returns Promise<Model<TData, TVirtual>>

  This instance

setValue

• setValue(key: any, value: any): void

  Set property value

  Parameters

  • key: any

    Property name (camelCase or snake_case)
  • value: any

    Property value

  Returns void

Static_ensureRevisionHandler

• _ensureRevisionHandler(
      this: RuntimeModel<
          JsonObject,
          JsonObject,
          Model<JsonObject, JsonObject>,
      >,
      handlerName: RevisionHandlerName,
  ): (this: Model, ...args: unknown[]) => unknown

  Ensure a revision handler is available for this model runtime

  Parameters

  • this: RuntimeModel<JsonObject, JsonObject, Model<JsonObject, JsonObject>>
  • handlerName: RevisionHandlerName

    Revision handler to initialize

  Returns (this: Model, ...args: unknown[]) => unknown

  Revision handler function

Static_getDbFieldName

• _getDbFieldName(propertyName: string): string

  Get the database field name for a given property name

  Parameters

  • propertyName: string

    Property name (camelCase or snake_case)

  Returns string

  Database field name (snake_case)

Static_registerFieldMapping

• _registerFieldMapping(camelCase: string, snakeCase: string): void

  Register a camelCase to snake_case field mapping

  Parameters

  • camelCase: string

    camelCase property name
  • snakeCase: string

    snake_case database column name

  Returns void

StaticaddManyRelated

• addManyRelated<
      TData extends JsonObject = JsonObject,
      TVirtual extends JsonObject = JsonObject,
  >(
      this: ModelConstructor<
          TData,
          TVirtual,
          ModelInstance<TData, TVirtual>,
          string,
      > & typeof Model & {
          _fieldMappings: Map<string, string>;
          _relations: Map<string, NormalizedRelationConfig>;
          _revisionHandlers?: Partial<
              Record<
                  RevisionHandlerName,
                  (this: Model, ...args: unknown[]) => unknown,
              >,
          >;
          _views: Map<
              string,
              ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
          >;
          dal: DataAccessLayer;
          options?: JsonObject;
          schema: ModelSchema<TData, TVirtual>;
          tableName: string;
      },
      relationName: string,
      sourceId: string,
      targetIds: string[],
      options?: { onConflict?: "error" | "ignore" },
  ): Promise<void>

  Batch-insert associations into a many-to-many junction table.

  This helper creates associations between a single source record and multiple target records by inserting rows into a junction table. It automatically handles:

  • Schema namespace prefixing for test isolation
  • Duplicate associations via ON CONFLICT DO NOTHING
  • Input validation with helpful error messages

  Type Parameters

  • TData extends JsonObject = JsonObject
  • TVirtual extends JsonObject = JsonObject

  Parameters

  • this: ModelConstructor<TData, TVirtual, ModelInstance<TData, TVirtual>, string> & typeof Model & {
        _fieldMappings: Map<string, string>;
        _relations: Map<string, NormalizedRelationConfig>;
        _revisionHandlers?: Partial<
            Record<
                RevisionHandlerName,
                (this: Model, ...args: unknown[]) => unknown,
            >,
        >;
        _views: Map<
            string,
            ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
        >;
        dal: DataAccessLayer;
        options?: JsonObject;
        schema: ModelSchema<TData, TVirtual>;
        tableName: string;
    }
  • relationName: string

    Name of the relation defined in the manifest (must have a through junction table)
  • sourceId: string

    ID of the source record to associate from
  • targetIds: string[]

    Array of target record IDs to associate with
  • Optionaloptions: { onConflict?: "error" | "ignore" }

    Optional configuration

    • OptionalonConflict?: "error" | "ignore"

      How to handle duplicate associations: 'ignore' (default) or 'error'

  Returns Promise<void>

  Throws

  If relation not found, has no junction table, or inputs are invalid

  Example

  // Associate a thing with multiple files
  await Thing.addManyRelated('files', thingId, [file1.id, file2.id]);
  
  // Associate a review with teams
  await Review.addManyRelated('teams', reviewId, teamIds, { onConflict: 'error' });
  Copy

Staticbetween

• between<
      TData extends JsonObject = JsonObject,
      TVirtual extends JsonObject = JsonObject,
      TInstance extends
          JsonObject & ModelInstanceCore<TData, TVirtual> = ModelInstance<
          TData,
          TVirtual,
      >,
      TRelations extends string = string,
  >(
      this: ModelConstructor<TData, TVirtual, TInstance, TRelations> & ModelConstructor<
          TData,
          TVirtual,
          ModelInstance<TData, TVirtual>,
          string,
      > & typeof Model & {
          _fieldMappings: Map<string, string>;
          _relations: Map<string, NormalizedRelationConfig>;
          _revisionHandlers?: Partial<
              Record<
                  RevisionHandlerName,
                  (this: Model, ...args: unknown[]) => unknown,
              >,
          >;
          _views: Map<
              string,
              ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
          >;
          dal: DataAccessLayer;
          options?: JsonObject;
          schema: ModelSchema<TData, TVirtual>;
          tableName: string;
      },
      startDate: Date,
      endDate: Date,
      options?: JsonObject,
  ): QueryBuilder<TData, TVirtual, TInstance, TRelations>

  Create query builder with date range filter

  Type Parameters

  • TData extends JsonObject = JsonObject
  • TVirtual extends JsonObject = JsonObject
  • TInstance extends JsonObject & ModelInstanceCore<TData, TVirtual> = ModelInstance<TData, TVirtual>
  • TRelations extends string = string

  Parameters

  • this: ModelConstructor<TData, TVirtual, TInstance, TRelations> & ModelConstructor<
        TData,
        TVirtual,
        ModelInstance<TData, TVirtual>,
        string,
    > & typeof Model & {
        _fieldMappings: Map<string, string>;
        _relations: Map<string, NormalizedRelationConfig>;
        _revisionHandlers?: Partial<
            Record<
                RevisionHandlerName,
                (this: Model, ...args: unknown[]) => unknown,
            >,
        >;
        _views: Map<
            string,
            ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
        >;
        dal: DataAccessLayer;
        options?: JsonObject;
        schema: ModelSchema<TData, TVirtual>;
        tableName: string;
    }
  • startDate: Date

    Start date
  • endDate: Date

    End date
  • options: JsonObject = {}

    Options for the range

  Returns QueryBuilder<TData, TVirtual, TInstance, TRelations>

  Query builder

Staticcontains

• contains<
      TData extends JsonObject = JsonObject,
      TVirtual extends JsonObject = JsonObject,
      TInstance extends
          JsonObject & ModelInstanceCore<TData, TVirtual> = ModelInstance<
          TData,
          TVirtual,
      >,
      TRelations extends string = string,
  >(
      this: ModelConstructor<TData, TVirtual, TInstance, TRelations> & ModelConstructor<
          TData,
          TVirtual,
          ModelInstance<TData, TVirtual>,
          string,
      > & typeof Model & {
          _fieldMappings: Map<string, string>;
          _relations: Map<string, NormalizedRelationConfig>;
          _revisionHandlers?: Partial<
              Record<
                  RevisionHandlerName,
                  (this: Model, ...args: unknown[]) => unknown,
              >,
          >;
          _views: Map<
              string,
              ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
          >;
          dal: DataAccessLayer;
          options?: JsonObject;
          schema: ModelSchema<TData, TVirtual>;
          tableName: string;
      },
      field: string,
      value: unknown,
  ): QueryBuilder<TData, TVirtual, TInstance, TRelations>

  Create query builder with array contains filter

  Type Parameters

  • TData extends JsonObject = JsonObject
  • TVirtual extends JsonObject = JsonObject
  • TInstance extends JsonObject & ModelInstanceCore<TData, TVirtual> = ModelInstance<TData, TVirtual>
  • TRelations extends string = string

  Parameters

  • this: ModelConstructor<TData, TVirtual, TInstance, TRelations> & ModelConstructor<
        TData,
        TVirtual,
        ModelInstance<TData, TVirtual>,
        string,
    > & typeof Model & {
        _fieldMappings: Map<string, string>;
        _relations: Map<string, NormalizedRelationConfig>;
        _revisionHandlers?: Partial<
            Record<
                RevisionHandlerName,
                (this: Model, ...args: unknown[]) => unknown,
            >,
        >;
        _views: Map<
            string,
            ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
        >;
        dal: DataAccessLayer;
        options?: JsonObject;
        schema: ModelSchema<TData, TVirtual>;
        tableName: string;
    }
  • field: string

    Field name
  • value: unknown

    Value to check for

  Returns QueryBuilder<TData, TVirtual, TInstance, TRelations>

  Query builder

Staticcreate

• create<
      TData extends JsonObject = JsonObject,
      TVirtual extends JsonObject = JsonObject,
  >(
      this: ModelRuntime<TData, TVirtual>,
      data: Partial<TData>,
      options?: JsonObject,
  ): Promise<ModelInstance<TData, TVirtual>>

  Create a new record

  Type Parameters

  • TData extends JsonObject = JsonObject
  • TVirtual extends JsonObject = JsonObject

  Parameters

  • this: ModelRuntime<TData, TVirtual>
  • data: Partial<TData>

    Record data
  • options: JsonObject = {}

    Creation options

  Returns Promise<ModelInstance<TData, TVirtual>>

  Created model instance

StaticcreateModel

• createModel<TData extends JsonObject, TVirtual extends JsonObject = JsonObject>(
      tableName: string,
      schema: ModelSchema<TData, TVirtual>,
      options: JsonObject,
      dal: DataAccessLayer,
  ): ModelConstructor<TData, TVirtual>

  Create a new model class

  Type Parameters

  • TData extends JsonObject
  • TVirtual extends JsonObject = JsonObject

  Parameters

  • tableName: string

    Database table name
  • schema: ModelSchema<TData, TVirtual>

    Model schema definition
  • options: JsonObject

    Model options
  • dal: DataAccessLayer

    DAL instance

  Returns ModelConstructor<TData, TVirtual>

  Model constructor

Staticdefine

• define<
      TData extends JsonObject = JsonObject,
      TVirtual extends JsonObject = JsonObject,
  >(
      this: ModelRuntime<TData, TVirtual>,
      name: string,
      method: (...args: unknown[]) => unknown,
  ): void

  Define an instance method on the model

  Type Parameters

  • TData extends JsonObject = JsonObject
  • TVirtual extends JsonObject = JsonObject

  Parameters

  • this: ModelRuntime<TData, TVirtual>
  • name: string

    Method name
  • method: (...args: unknown[]) => unknown

    Method function

  Returns void

StaticdefineRelation

• defineRelation(name: string, config: JsonObject): void

  Register relation metadata for the model

  Parameters

  • name: string

    Relation name
  • config: JsonObject

    Relation configuration

  Returns void

StaticdefineView

• defineView<TView extends JsonObject = JsonObject>(
      name: string,
      definition: ModelViewDefinition<
          ModelInstance<JsonObject, JsonObject>,
          TView,
      >,
  ): void

  Register a named projection/view for this model.

  Type Parameters

  • TView extends JsonObject = JsonObject

  Parameters

  • name: string

    Unique view identifier
  • definition: ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, TView>

    View configuration

  Returns void

Staticdelete

• delete<
      TData extends JsonObject = JsonObject,
      TVirtual extends JsonObject = JsonObject,
      TInstance extends
          JsonObject & ModelInstanceCore<TData, TVirtual> = ModelInstance<
          TData,
          TVirtual,
      >,
      TRelations extends string = string,
  >(
      this: ModelConstructor<TData, TVirtual, TInstance, TRelations> & ModelConstructor<
          TData,
          TVirtual,
          ModelInstance<TData, TVirtual>,
          string,
      > & typeof Model & {
          _fieldMappings: Map<string, string>;
          _relations: Map<string, NormalizedRelationConfig>;
          _revisionHandlers?: Partial<
              Record<
                  RevisionHandlerName,
                  (this: Model, ...args: unknown[]) => unknown,
              >,
          >;
          _views: Map<
              string,
              ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
          >;
          dal: DataAccessLayer;
          options?: JsonObject;
          schema: ModelSchema<TData, TVirtual>;
          tableName: string;
      },
      id: string,
  ): Promise<boolean>

  Delete a record by ID

  Type Parameters

  • TData extends JsonObject = JsonObject
  • TVirtual extends JsonObject = JsonObject
  • TInstance extends JsonObject & ModelInstanceCore<TData, TVirtual> = ModelInstance<TData, TVirtual>
  • TRelations extends string = string

  Parameters

  • this: ModelConstructor<TData, TVirtual, TInstance, TRelations> & ModelConstructor<
        TData,
        TVirtual,
        ModelInstance<TData, TVirtual>,
        string,
    > & typeof Model & {
        _fieldMappings: Map<string, string>;
        _relations: Map<string, NormalizedRelationConfig>;
        _revisionHandlers?: Partial<
            Record<
                RevisionHandlerName,
                (this: Model, ...args: unknown[]) => unknown,
            >,
        >;
        _views: Map<
            string,
            ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
        >;
        dal: DataAccessLayer;
        options?: JsonObject;
        schema: ModelSchema<TData, TVirtual>;
        tableName: string;
    }
  • id: string

    Record ID

  Returns Promise<boolean>

  Success status

StaticfetchView

• fetchView<
      TData extends JsonObject = JsonObject,
      TVirtual extends JsonObject = JsonObject,
      TView extends JsonObject = JsonObject,
  >(
      this: ModelConstructor<
          TData,
          TVirtual,
          ModelInstance<TData, TVirtual>,
          string,
      > & typeof Model & {
          _fieldMappings: Map<string, string>;
          _relations: Map<string, NormalizedRelationConfig>;
          _revisionHandlers?: Partial<
              Record<
                  RevisionHandlerName,
                  (this: Model, ...args: unknown[]) => unknown,
              >,
          >;
          _views: Map<
              string,
              ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
          >;
          dal: DataAccessLayer;
          options?: JsonObject;
          schema: ModelSchema<TData, TVirtual>;
          tableName: string;
      },
      name: string,
      options?: ModelViewFetchOptions<
          TData,
          TVirtual,
          ModelInstance<TData, TVirtual>,
      >,
  ): Promise<TView[]>

  Execute a view query using the provided builder configuration.

  Type Parameters

  • TData extends JsonObject = JsonObject
  • TVirtual extends JsonObject = JsonObject
  • TView extends JsonObject = JsonObject

  Parameters

  • this: ModelConstructor<TData, TVirtual, ModelInstance<TData, TVirtual>, string> & typeof Model & {
        _fieldMappings: Map<string, string>;
        _relations: Map<string, NormalizedRelationConfig>;
        _revisionHandlers?: Partial<
            Record<
                RevisionHandlerName,
                (this: Model, ...args: unknown[]) => unknown,
            >,
        >;
        _views: Map<
            string,
            ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
        >;
        dal: DataAccessLayer;
        options?: JsonObject;
        schema: ModelSchema<TData, TVirtual>;
        tableName: string;
    }
  • name: string

    Registered view name
  • options: ModelViewFetchOptions<TData, TVirtual, ModelInstance<TData, TVirtual>> = {}

    View fetch options

  Returns Promise<TView[]>

  Array of projected view objects

Staticget

• get<
      TData extends JsonObject = JsonObject,
      TVirtual extends JsonObject = JsonObject,
  >(
      this: ModelRuntime<TData, TVirtual>,
      id: string,
      options?: GetOptions,
  ): Promise<Model<TData, TVirtual>>

  Get a record by ID

  Type Parameters

  • TData extends JsonObject = JsonObject
  • TVirtual extends JsonObject = JsonObject

  Parameters

  • this: ModelRuntime<TData, TVirtual>
  • id: string

    Record ID
  • options: GetOptions = {}

    Query options

    • includeSensitive

      Array of sensitive field names to include

  Returns Promise<Model<TData, TVirtual>>

  Model instance

StaticgetAll

• getAll<
      TData extends JsonObject = JsonObject,
      TVirtual extends JsonObject = JsonObject,
  >(
      this: ModelRuntime<TData, TVirtual>,
      ...ids: string[],
  ): Promise<Model<TData, TVirtual>[]>

  Get multiple records by IDs

  Type Parameters

  • TData extends JsonObject = JsonObject
  • TVirtual extends JsonObject = JsonObject

  Parameters

  • this: ModelRuntime<TData, TVirtual>
  • ...ids: string[]

    Record IDs

  Returns Promise<Model<TData, TVirtual>[]>

  Array of model instances

StaticgetColumnNames

• getColumnNames(includeSensitive?: string[]): string[]

  Get list of database column names including specified sensitive fields

  Parameters

  • includeSensitive: string[] = []

    Array of sensitive field names to include

  Returns string[]

  Array of database column names

StaticgetJoin

• getJoin<
      TData extends JsonObject = JsonObject,
      TVirtual extends JsonObject = JsonObject,
      TInstance extends
          JsonObject & ModelInstanceCore<TData, TVirtual> = ModelInstance<
          TData,
          TVirtual,
      >,
      TRelations extends string = string,
  >(
      this: ModelConstructor<TData, TVirtual, TInstance, TRelations> & ModelConstructor<
          TData,
          TVirtual,
          ModelInstance<TData, TVirtual>,
          string,
      > & typeof Model & {
          _fieldMappings: Map<string, string>;
          _relations: Map<string, NormalizedRelationConfig>;
          _revisionHandlers?: Partial<
              Record<
                  RevisionHandlerName,
                  (this: Model, ...args: unknown[]) => unknown,
              >,
          >;
          _views: Map<
              string,
              ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
          >;
          dal: DataAccessLayer;
          options?: JsonObject;
          schema: ModelSchema<TData, TVirtual>;
          tableName: string;
      },
      joinSpec: JsonObject,
  ): QueryBuilder<TData, TVirtual, TInstance, TRelations>

  Create query builder with joins

  Type Parameters

  • TData extends JsonObject = JsonObject
  • TVirtual extends JsonObject = JsonObject
  • TInstance extends JsonObject & ModelInstanceCore<TData, TVirtual> = ModelInstance<TData, TVirtual>
  • TRelations extends string = string

  Parameters

  • this: ModelConstructor<TData, TVirtual, TInstance, TRelations> & ModelConstructor<
        TData,
        TVirtual,
        ModelInstance<TData, TVirtual>,
        string,
    > & typeof Model & {
        _fieldMappings: Map<string, string>;
        _relations: Map<string, NormalizedRelationConfig>;
        _revisionHandlers?: Partial<
            Record<
                RevisionHandlerName,
                (this: Model, ...args: unknown[]) => unknown,
            >,
        >;
        _views: Map<
            string,
            ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
        >;
        dal: DataAccessLayer;
        options?: JsonObject;
        schema: ModelSchema<TData, TVirtual>;
        tableName: string;
    }
  • joinSpec: JsonObject

    Join specification

  Returns QueryBuilder<TData, TVirtual, TInstance, TRelations>

  Query builder

StaticgetMultipleNotStaleOrDeleted

• getMultipleNotStaleOrDeleted<
      TData extends JsonObject = JsonObject,
      TVirtual extends JsonObject = JsonObject,
  >(
      this: ModelRuntime<TData, TVirtual>,
      ids: string[],
  ): FilterWhereQueryBuilder<
      TData,
      TVirtual,
      ModelInstance<TData, TVirtual>,
      string,
  >

  Get multiple records by IDs, excluding stale and deleted revisions

  Type Parameters

  • TData extends JsonObject = JsonObject
  • TVirtual extends JsonObject = JsonObject

  Parameters

  • this: ModelRuntime<TData, TVirtual>
  • ids: string[]

    Record IDs

  Returns FilterWhereQueryBuilder<TData, TVirtual, ModelInstance<TData, TVirtual>, string>

  Query builder for chaining

StaticgetRelation

• getRelation(name: string): NormalizedRelationConfig

  Retrieve relation metadata by name

  Parameters

  • name: string

    Relation name

  Returns NormalizedRelationConfig

  Stored relation configuration

StaticgetRelations

• getRelations(): { config: NormalizedRelationConfig; name: string }[]

  Retrieve all registered relation metadata

  Returns { config: NormalizedRelationConfig; name: string }[]

  Array of relation configurations with names

StaticgetSafeColumnNames

• getSafeColumnNames(): string[]

  Get list of non-sensitive database column names for safe querying Excludes fields marked as sensitive and virtual fields

  Returns string[]

  Array of database column names

StaticgetSensitiveFieldNames

• getSensitiveFieldNames(): string[]

  Get list of sensitive field names in the schema

  Returns string[]

  Array of field names (camelCase)

StaticgetView

• getView<TView extends JsonObject = JsonObject>(
      name: string,
  ): ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, TView>

  Retrieve the view definition for a registered projection.

  Type Parameters

  • TView extends JsonObject = JsonObject

  Parameters

  • name: string

    View identifier

  Returns ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, TView>

  Stored view definition or null if missing

Staticlimit

• limit<
      TData extends JsonObject = JsonObject,
      TVirtual extends JsonObject = JsonObject,
      TInstance extends
          JsonObject & ModelInstanceCore<TData, TVirtual> = ModelInstance<
          TData,
          TVirtual,
      >,
      TRelations extends string = string,
  >(
      this: ModelConstructor<TData, TVirtual, TInstance, TRelations> & ModelConstructor<
          TData,
          TVirtual,
          ModelInstance<TData, TVirtual>,
          string,
      > & typeof Model & {
          _fieldMappings: Map<string, string>;
          _relations: Map<string, NormalizedRelationConfig>;
          _revisionHandlers?: Partial<
              Record<
                  RevisionHandlerName,
                  (this: Model, ...args: unknown[]) => unknown,
              >,
          >;
          _views: Map<
              string,
              ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
          >;
          dal: DataAccessLayer;
          options?: JsonObject;
          schema: ModelSchema<TData, TVirtual>;
          tableName: string;
      },
      count: number,
  ): QueryBuilder<TData, TVirtual, TInstance, TRelations>

  Create query builder with limit

  Type Parameters

  • TData extends JsonObject = JsonObject
  • TVirtual extends JsonObject = JsonObject
  • TInstance extends JsonObject & ModelInstanceCore<TData, TVirtual> = ModelInstance<TData, TVirtual>
  • TRelations extends string = string

  Parameters

  • this: ModelConstructor<TData, TVirtual, TInstance, TRelations> & ModelConstructor<
        TData,
        TVirtual,
        ModelInstance<TData, TVirtual>,
        string,
    > & typeof Model & {
        _fieldMappings: Map<string, string>;
        _relations: Map<string, NormalizedRelationConfig>;
        _revisionHandlers?: Partial<
            Record<
                RevisionHandlerName,
                (this: Model, ...args: unknown[]) => unknown,
            >,
        >;
        _views: Map<
            string,
            ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
        >;
        dal: DataAccessLayer;
        options?: JsonObject;
        schema: ModelSchema<TData, TVirtual>;
        tableName: string;
    }
  • count: number

    Limit count

  Returns QueryBuilder<TData, TVirtual, TInstance, TRelations>

  Query builder

StaticloadManyRelated

• loadManyRelated<
      TData extends JsonObject = JsonObject,
      TVirtual extends JsonObject = JsonObject,
  >(
      this: ModelConstructor<
          TData,
          TVirtual,
          ModelInstance<TData, TVirtual>,
          string,
      > & typeof Model & {
          _fieldMappings: Map<string, string>;
          _relations: Map<string, NormalizedRelationConfig>;
          _revisionHandlers?: Partial<
              Record<
                  RevisionHandlerName,
                  (this: Model, ...args: unknown[]) => unknown,
              >,
          >;
          _views: Map<
              string,
              ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
          >;
          dal: DataAccessLayer;
          options?: JsonObject;
          schema: ModelSchema<TData, TVirtual>;
          tableName: string;
      },
      relationName: string,
      sourceIds: string[],
  ): Promise<Map<string, ModelInstance<JsonObject, JsonObject>[]>>

  Batch-load many-to-many related records through a junction table.

  Given an array of source IDs, fetches all related records and groups them by source ID. Handles both direct and through (junction table) relations, automatically applying revision system guards when needed.

  Type Parameters

  • TData extends JsonObject = JsonObject
  • TVirtual extends JsonObject = JsonObject

  Parameters

  • this: ModelConstructor<TData, TVirtual, ModelInstance<TData, TVirtual>, string> & typeof Model & {
        _fieldMappings: Map<string, string>;
        _relations: Map<string, NormalizedRelationConfig>;
        _revisionHandlers?: Partial<
            Record<
                RevisionHandlerName,
                (this: Model, ...args: unknown[]) => unknown,
            >,
        >;
        _views: Map<
            string,
            ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
        >;
        dal: DataAccessLayer;
        options?: JsonObject;
        schema: ModelSchema<TData, TVirtual>;
        tableName: string;
    }
  • relationName: string

    Name of the relation from the manifest
  • sourceIds: string[]

    Array of source record IDs to load relations for

  Returns Promise<Map<string, ModelInstance<JsonObject, JsonObject>[]>>

  Map of source ID to array of related model instances

  Example

  // Load all teams for multiple reviews
  const reviewTeamMap = await Review.loadManyRelated('teams', reviewIds);
  reviewTeamMap.get(reviewId) // => TeamInstance[]
  Copy

StaticorderBy

• orderBy<
      TData extends JsonObject = JsonObject,
      TVirtual extends JsonObject = JsonObject,
      TInstance extends
          JsonObject & ModelInstanceCore<TData, TVirtual> = ModelInstance<
          TData,
          TVirtual,
      >,
      TRelations extends string = string,
  >(
      this: ModelConstructor<TData, TVirtual, TInstance, TRelations> & ModelConstructor<
          TData,
          TVirtual,
          ModelInstance<TData, TVirtual>,
          string,
      > & typeof Model & {
          _fieldMappings: Map<string, string>;
          _relations: Map<string, NormalizedRelationConfig>;
          _revisionHandlers?: Partial<
              Record<
                  RevisionHandlerName,
                  (this: Model, ...args: unknown[]) => unknown,
              >,
          >;
          _views: Map<
              string,
              ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
          >;
          dal: DataAccessLayer;
          options?: JsonObject;
          schema: ModelSchema<TData, TVirtual>;
          tableName: string;
      },
      field: string,
      direction?: string,
  ): QueryBuilder<TData, TVirtual, TInstance, TRelations>

  Create query builder for ordering

  Type Parameters

  • TData extends JsonObject = JsonObject
  • TVirtual extends JsonObject = JsonObject
  • TInstance extends JsonObject & ModelInstanceCore<TData, TVirtual> = ModelInstance<TData, TVirtual>
  • TRelations extends string = string

  Parameters

  • this: ModelConstructor<TData, TVirtual, TInstance, TRelations> & ModelConstructor<
        TData,
        TVirtual,
        ModelInstance<TData, TVirtual>,
        string,
    > & typeof Model & {
        _fieldMappings: Map<string, string>;
        _relations: Map<string, NormalizedRelationConfig>;
        _revisionHandlers?: Partial<
            Record<
                RevisionHandlerName,
                (this: Model, ...args: unknown[]) => unknown,
            >,
        >;
        _views: Map<
            string,
            ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
        >;
        dal: DataAccessLayer;
        options?: JsonObject;
        schema: ModelSchema<TData, TVirtual>;
        tableName: string;
    }
  • field: string

    Field to order by
  • direction: string = 'ASC'

    Sort direction (ASC/DESC)

  Returns QueryBuilder<TData, TVirtual, TInstance, TRelations>

  Query builder

Staticupdate

• update<
      TData extends JsonObject = JsonObject,
      TVirtual extends JsonObject = JsonObject,
  >(
      this: ModelRuntime<TData, TVirtual>,
      id: string,
      data: Partial<TData>,
  ): Promise<ModelInstance<TData, TVirtual>>

  Type Parameters

  • TData extends JsonObject = JsonObject
  • TVirtual extends JsonObject = JsonObject

  Parameters

  • this: ModelRuntime<TData, TVirtual>
  • id: string
  • data: Partial<TData>

  Returns Promise<ModelInstance<TData, TVirtual>>