Class Controller

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

Model

qcolumns

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'
  });
  Copy

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.

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.

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

• meta(): Promise<IStatusCode>

• Returns metadata information about the table.

  Returns Promise<IStatusCode>

  The promise with table metadata.

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.

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.

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.