Class Controller

Controller

Description

A controller class for handling database queries using Objection.js models.

Constructors

constructor

Properties

Model qcolumns

Methods

applyOrderByLite delete deleteWhere error findTypeString insert insertWithIdentity list meta selectById selectByName selectOne selectOneActive success successMerge update

Constructors

constructor

  • new Controller(SqliteModel, options?): Controller

  • Parameters

    • SqliteModel: typeof Model

      The Objection.js model.

    • options: {
          searchIn?: string[];
      } = {}

      Additional options for the controller.

      • OptionalsearchIn?: string[]

        Columns to search in by default.

    Returns Controller

Properties

Model

Model: typeof Model

qcolumns

qcolumns: undefined | string[]

Methods

applyOrderByLite

  • applyOrderByLite(queryBuilderIn, orderBy?): void

  • Applies multi-column ordering to an Objection or Knex query builder.

    Accepts an object like { created_at: 'desc', 'user.name': 'asc' }.

    • Dotted paths (e.g. user.name) are used as provided. Ensure related tables have been joined via joinRelated or withGraphJoined.
    • Columns without a dot are qualified with the model table name.
    • Any invalid direction defaults to 'asc'.

    Parameters

    • queryBuilderIn: any

      Query builder instance to apply ordering to.

    • orderBy: Record<string, string> = {}

      Mapping of column paths to sort direction.

    Returns void

    Example

    const query = SampleModel.query();
    controller.applyOrderByLite(query, {
      created_at: 'desc',
      'profile.name': 'asc'
    });

delete

  • delete(param0, queryBuilder?): Promise<IStatusCode>

  • Deletes records by ID(s).

    Parameters

    • param0: IIds

      The ID or IDs of records to delete.

    • OptionalqueryBuilder: any

      Optional query builder instance.

    Returns Promise<IStatusCode>

    The promise of the resulting data.

deleteWhere

  • deleteWhere(whereData, queryBuilder?): Promise<IStatusCode>

  • Deletes records based on where clause.

    Parameters

    • whereData: WhereMethod<any>

      Criteria for delete operation.

    • OptionalqueryBuilder: any

      Optional query builder instance.

    Returns Promise<IStatusCode>

    The promise of the resulting data.

Protectederror

  • error(errorObj?, status?, code?): IStatusCode

  • Formats an error response object.

    Parameters

    • OptionalerrorObj: any

      The error object or message.

    • Optionalstatus: number = 500

      The HTTP status code.

    • Optionalcode: number = 0

      Additional status code.

    Returns IStatusCode

    The error response object.

findTypeString

  • findTypeString(ModelIn?): string[]

  • Finds string type columns in the model's JSON schema.

    Parameters

    • ModelIn: typeof Model = ...

      The model to inspect. Defaults to this.Model.

    Returns string[]

    A list of string type column names.

insert

  • insert(data, queryBuilder?): Promise<IStatusCode>

  • Inserts one or multiple records.

    Parameters

    • data: Record<string, any>

      The data to insert.

    • OptionalqueryBuilder: any

      Optional query builder instance.

    Returns Promise<IStatusCode>

    The promise of the resulting data.

ProtectedinsertWithIdentity

  • insertWithIdentity(payload): null | Promise<IStatusCode>

  • MSSQL treats the primary key as an IDENTITY column and rejects explicit values unless IDENTITY_INSERT is enabled. This runs flat inserts that carry an explicit primary key as a single raw batch (the SET and the INSERT must share the same round-trip on MSSQL), and returns null for any other engine/shape so callers fall back to the normal insertGraph.

    Parameters

    • payload: any

      The record or records to insert.

    Returns null | Promise<IStatusCode>

    The result, or null when the special handling does not apply.

list

  • list(dataSearch, queryBuilder?): Promise<IStatusCode>

  • Lists records based on search criteria.

    Parameters

    • dataSearch: ISearch

      The search criteria.

    • OptionalqueryBuilder: any

      Optional query builder instance.

    Returns Promise<IStatusCode>

    The promise of the resulting data.

meta

selectById

  • selectById(param0, queryBuilder?): Promise<IStatusCode>

  • Selects a record by its ID.

    Parameters

    • param0: IIds

      The ID or IDs to select.

    • OptionalqueryBuilder: any

      Optional query builder instance.

    Returns Promise<IStatusCode>

    The promise of the resulting data.

selectByName

  • selectByName(param0, queryBuilder?): Promise<IStatusCode>

  • Selects one record by its name field.

    Parameters

    • param0: {
          name: string;
      }

      Object containing the name parameter.

      • name: string

        The name to search for.

    • OptionalqueryBuilder: any

      Optional query builder instance.

    Returns Promise<IStatusCode>

    The promise of the resulting data.

selectOne

  • selectOne(find, queryBuilder?): Promise<IStatusCode>

  • Selects one record based on given criteria without considering active state.

    Parameters

    • find: object

      Criteria to find the record.

    • OptionalqueryBuilder: any

      Optional query builder instance.

    Returns Promise<IStatusCode>

    The promise of the resulting data.

selectOneActive

  • selectOneActive(find, queryBuilder?): Promise<IStatusCode>

  • Selects one active record based on given criteria.

    Parameters

    • find: object

      Criteria to find the record.

    • OptionalqueryBuilder: any

      Optional query builder instance.

    Returns Promise<IStatusCode>

    The promise of the resulting data.

Protectedsuccess

  • success(data?, status?, code?): IStatusCode

  • Formats a successful response object.

    Parameters

    • Optionaldata: any

      The data to return in the response.

    • Optionalstatus: number = 200

      The HTTP status code.

    • Optionalcode: number = 0

      Additional status code.

    Returns IStatusCode

    The success response object.

ProtectedsuccessMerge

  • successMerge(data?, status?, code?): IStatusCode

  • Merges additional data into a successful response object.

    Parameters

    • Optionaldata: any

      The data to return in the response.

    • Optionalstatus: number = 200

      The HTTP status code.

    • Optionalcode: number = 0

      Additional status code.

    Returns IStatusCode

    The merged success response object.

update

  • update(data, queryBuilder?): Promise<IStatusCode>

  • Updates records using an upsert operation.

    Parameters

    • data: Record<string, any>

      The data for upsert.

    • OptionalqueryBuilder: any

      Optional query builder instance.

    Returns Promise<IStatusCode>

    The promise of the resulting data.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods