Class TakaroModel

$modelClass

QueryBuilderType

StaticBelongsToOneRelation

StaticcolumnNameMappers

StaticdbRefProp

Static OptionaldefaultGraphOptions

Staticfn

StaticHasManyRelation

StaticHasOneRelation

StaticHasOneThroughRelation

StaticjsonAttributes

StaticjsonSchema

StaticManyToManyRelation

StaticmodelPaths

StaticpickJsonSchemaProperties

StaticpropRefRegex

StaticQueryBuilder

Staticraw

Staticref

StaticrelatedFindQueryMutates

StaticrelatedInsertQueryMutates

StaticrelationMappings

StatictableName

StaticuidProp

StaticuidRefProp

StaticuseLimitInFirst

StaticvirtualAttributes

$afterDelete

• $afterDelete(queryContext: QueryContext): void | Promise<any>

  Parameters

  • queryContext: QueryContext

  Returns void | Promise<any>

$afterFind

• $afterFind(queryContext: QueryContext): void | Promise<any>

  Parameters

  • queryContext: QueryContext

  Returns void | Promise<any>

$afterInsert

• $afterInsert(queryContext: QueryContext): void | Promise<any>

  Parameters

  • queryContext: QueryContext

  Returns void | Promise<any>

$afterUpdate

• $afterUpdate(opt: ModelOptions, queryContext: QueryContext): void | Promise<any>

  Parameters

  • opt: ModelOptions
  • queryContext: QueryContext

  Returns void | Promise<any>

$afterValidate

• $afterValidate(json: Pojo, opt: ModelOptions): void

  Parameters

  • json: Pojo
  • opt: ModelOptions

  Returns void

$appendRelated

• $appendRelated<RM extends Model>(
      relation: String | Relation,
      related: RM | RM[] | null | undefined,
  ): this

  Type Parameters

  • RM extends Model

  Parameters

  • relation: String | Relation
  • related: RM | RM[] | null | undefined

  Returns this

$beforeDelete

• $beforeDelete(queryContext: QueryContext): void | Promise<any>

  Parameters

  • queryContext: QueryContext

  Returns void | Promise<any>

$beforeValidate

• $beforeValidate(
      jsonSchema: JSONSchema,
      json: Pojo,
      opt: ModelOptions,
  ): JSONSchema

  Parameters

  • jsonSchema: JSONSchema
  • json: Pojo
  • opt: ModelOptions

  Returns JSONSchema

$clone

• $clone(opt?: CloneOptions): this

  Parameters

  • Optionalopt: CloneOptions

  Returns this

$fetchGraph

• $fetchGraph(
      expression: RelationExpression<M>,
      options?: FetchGraphOptions,
  ): QueryBuilder<TakaroModel>

  Parameters

  • expression: RelationExpression<M>
  • Optionaloptions: FetchGraphOptions

  Returns QueryBuilder<TakaroModel>

$formatDatabaseJson

• $formatDatabaseJson(json: Pojo): Pojo

  Parameters

  • json: Pojo

  Returns Pojo

$formatJson

• $formatJson(json: Pojo): Pojo

  Parameters

  • json: Pojo

  Returns Pojo

$id

• $id(id: any): void

  Parameters

  • id: any

  Returns void

• $id(): any

  Returns any

$knex

• $knex(): Knex

  Returns Knex

$omitFromDatabaseJson

• $omitFromDatabaseJson(
      keys: string | string[] | { [key: string]: boolean },
  ): this

  Parameters

  • keys: string | string[] | { [key: string]: boolean }

  Returns this

$omitFromJson

• $omitFromJson(keys: string | string[] | { [key: string]: boolean }): this

  Parameters

  • keys: string | string[] | { [key: string]: boolean }

  Returns this

$parseDatabaseJson

• $parseDatabaseJson(json: Pojo): Pojo

  Parameters

  • json: Pojo

  Returns Pojo

$parseJson

• $parseJson(json: Pojo, opt?: ModelOptions): Pojo

  Parameters

  • json: Pojo
  • Optionalopt: ModelOptions

  Returns Pojo

$query

• $query(trxOrKnex?: TransactionOrKnex): QueryBuilder<TakaroModel>

  Parameters

  • OptionaltrxOrKnex: TransactionOrKnex

  Returns QueryBuilder<TakaroModel>

$relatedQuery

• $relatedQuery<K extends keyof TakaroModel>(
      relationName: K,
      trxOrKnex?: TransactionOrKnex,
  ): RelatedQueryBuilder<TakaroModel[K]>

  Type Parameters

  • K extends keyof TakaroModel

  Parameters

  • relationName: K
  • OptionaltrxOrKnex: TransactionOrKnex

  Returns RelatedQueryBuilder<TakaroModel[K]>

• $relatedQuery<RM extends Model>(
      relationName: string,
      trxOrKnex?: TransactionOrKnex,
  ): QueryBuilderType<RM>

  Type Parameters

  • RM extends Model

  Parameters

  • relationName: string
  • OptionaltrxOrKnex: TransactionOrKnex

  Returns QueryBuilderType<RM>

$set

• $set(obj: Pojo): this

  Parameters

  • obj: Pojo

  Returns this

$setDatabaseJson

• $setDatabaseJson(json: object): this

  Parameters

  • json: object

  Returns this

$setJson

• $setJson(json: object, opt?: ModelOptions): this

  Parameters

  • json: object
  • Optionalopt: ModelOptions

  Returns this

$setRelated

• $setRelated<RM extends Model>(
      relation: String | Relation,
      related: RM | RM[] | null | undefined,
  ): this

  Type Parameters

  • RM extends Model

  Parameters

  • relation: String | Relation
  • related: RM | RM[] | null | undefined

  Returns this

$toDatabaseJson

• $toDatabaseJson(): Pojo

  Returns Pojo

$toJson

• $toJson(opt?: ToJsonOptions): ModelObject<this>

  Parameters

  • Optionalopt: ToJsonOptions

  Returns ModelObject<this>

$transaction

• $transaction(): Knex

  Returns Knex

$traverse

• $traverse(filterConstructor: typeof Model, traverser: TraverserFunction): this

  Parameters

  • filterConstructor: typeof Model
  • traverser: TraverserFunction

  Returns this

• $traverse(traverser: TraverserFunction): this

  Parameters

  • traverser: TraverserFunction

  Returns this

$traverseAsync

• $traverseAsync(
      filterConstructor: typeof Model,
      traverser: TraverserFunction,
  ): Promise<TakaroModel>

  Parameters

  • filterConstructor: typeof Model
  • traverser: TraverserFunction

  Returns Promise<TakaroModel>

• $traverseAsync(traverser: TraverserFunction): Promise<TakaroModel>

  Parameters

  • traverser: TraverserFunction

  Returns Promise<TakaroModel>

$validate

• $validate(json?: Pojo, opt?: ModelOptions): Pojo

  Parameters

  • Optionaljson: Pojo
  • Optionalopt: ModelOptions

  Returns Pojo

toJSON

• toJSON(opt?: ToJsonOptions): ModelObject<this>

  Parameters

  • Optionalopt: ToJsonOptions

  Returns ModelObject<this>

StaticafterDelete

• afterDelete(args: StaticHookArguments<any>): any

  Parameters

  • args: StaticHookArguments<any>

  Returns any

StaticafterFind

• afterFind(args: StaticHookArguments<any>): any

  Parameters

  • args: StaticHookArguments<any>

  Returns any

StaticafterInsert

• afterInsert(args: StaticHookArguments<any>): any

  Parameters

  • args: StaticHookArguments<any>

  Returns any

StaticafterUpdate

• afterUpdate(args: StaticHookArguments<any>): any

  Parameters

  • args: StaticHookArguments<any>

  Returns any

StaticbeforeDelete

• beforeDelete(args: StaticHookArguments<any>): any

  Parameters

  • args: StaticHookArguments<any>

  Returns any

StaticbeforeFind

• beforeFind(args: StaticHookArguments<any>): any

  Parameters

  • args: StaticHookArguments<any>

  Returns any

StaticbeforeInsert

• beforeInsert(args: StaticHookArguments<any>): any

  Parameters

  • args: StaticHookArguments<any>

  Returns any

StaticbeforeUpdate

• beforeUpdate(args: StaticHookArguments<any>): any

  Parameters

  • args: StaticHookArguments<any>

  Returns any

StaticbindKnex

• bindKnex<M>(this: M, trxOrKnex: TransactionOrKnex): M

  Type Parameters

  • M

  Parameters

  • this: M
  • trxOrKnex: TransactionOrKnex

  Returns M

StaticbindTransaction

• bindTransaction<M>(this: M, trxOrKnex: TransactionOrKnex): M

  Type Parameters

  • M

  Parameters

  • this: M
  • trxOrKnex: TransactionOrKnex

  Returns M

StaticcolumnNameToPropertyName

• columnNameToPropertyName(columnName: string): string

  Parameters

  • columnName: string

  Returns string

StaticcreateNotFoundError

• createNotFoundError(
      queryContext: QueryContext,
      args: CreateNotFoundErrorArgs,
  ): Error

  Parameters

  • queryContext: QueryContext
  • args: CreateNotFoundErrorArgs

  Returns Error

StaticcreateValidationError

• createValidationError(args: CreateValidationErrorArgs): Error

  Parameters

  • args: CreateValidationErrorArgs

  Returns Error

StaticcreateValidator

• createValidator(): Validator

  Returns Validator

StaticfetchGraph

• fetchGraph<M extends Model>(
      this: Constructor<M>,
      modelOrObject: PartialModelObject<M>,
      expression: RelationExpression<M>,
      options?: FetchGraphOptions,
  ): SingleQueryBuilder<QueryBuilderType<M>>

  Type Parameters

  • M extends Model

  Parameters

  • this: Constructor<M>
  • modelOrObject: PartialModelObject<M>
  • expression: RelationExpression<M>
  • Optionaloptions: FetchGraphOptions

  Returns SingleQueryBuilder<QueryBuilderType<M>>

• fetchGraph<M extends Model>(
      this: Constructor<M>,
      modelOrObject: PartialModelObject<M>[],
      expression: RelationExpression<M>,
      options?: FetchGraphOptions,
  ): QueryBuilderType<M>

  Type Parameters

  • M extends Model

  Parameters

  • this: Constructor<M>
  • modelOrObject: PartialModelObject<M>[]
  • expression: RelationExpression<M>
  • Optionaloptions: FetchGraphOptions

  Returns QueryBuilderType<M>

StaticfetchTableMetadata

• fetchTableMetadata(opt?: FetchTableMetadataOptions): Promise<TableMetadata>

  Parameters

  • Optionalopt: FetchTableMetadataOptions

  Returns Promise<TableMetadata>

StaticfromDatabaseJson

• fromDatabaseJson<M extends Model>(this: Constructor<M>, json: object): M

  Type Parameters

  • M extends Model

  Parameters

  • this: Constructor<M>
  • json: object

  Returns M

StaticfromJson

• fromJson<M extends Model>(
      this: Constructor<M>,
      json: object,
      opt?: ModelOptions,
  ): M

  Type Parameters

  • M extends Model

  Parameters

  • this: Constructor<M>
  • json: object
  • Optionalopt: ModelOptions

  Returns M

StaticgetRelation

• getRelation(name: string): Relation

  Parameters

  • name: string

  Returns Relation

StaticgetRelations

• getRelations(): Relations

  Returns Relations

Staticknex

• knex(knex?: Knex<any, any[]>): Knex

  Parameters

  • Optionalknex: Knex<any, any[]>

  Returns Knex

StaticknexQuery

• knexQuery(): QueryBuilder

  Returns QueryBuilder

StaticpropertyNameToColumnName

• propertyNameToColumnName(propertyName: string): string

  Parameters

  • propertyName: string

  Returns string

Staticquery

• query<M extends Model>(
      this: Constructor<M>,
      trxOrKnex?: TransactionOrKnex,
  ): QueryBuilderType<M>

  Type Parameters

  • M extends Model

  Parameters

  • this: Constructor<M>
  • OptionaltrxOrKnex: TransactionOrKnex

  Returns QueryBuilderType<M>

StaticrelatedQuery

• relatedQuery<M extends Model, K extends string | number | symbol>(
      this: ConstructorType<M>,
      relationName: K,
      trxOrKnex?: TransactionOrKnex,
  ): ArrayRelatedQueryBuilder<M[K]>

  Type Parameters

  • M extends Model
  • K extends string | number | symbol

  Parameters

  • this: ConstructorType<M>
  • relationName: K
  • OptionaltrxOrKnex: TransactionOrKnex

  Returns ArrayRelatedQueryBuilder<M[K]>

• relatedQuery<RM extends Model>(
      relationName: string,
      trxOrKnex?: TransactionOrKnex,
  ): QueryBuilderType<RM>

  Type Parameters

  • RM extends Model

  Parameters

  • relationName: string
  • OptionaltrxOrKnex: TransactionOrKnex

  Returns QueryBuilderType<RM>

StaticstartTransaction

• startTransaction(knexOrTransaction?: TransactionOrKnex): Promise<Transaction>

  Parameters

  • OptionalknexOrTransaction: TransactionOrKnex

  Returns Promise<Transaction>

StatictableMetadata

• tableMetadata(opt?: TableMetadataOptions): TableMetadata

  Parameters

  • Optionalopt: TableMetadataOptions

  Returns TableMetadata

Statictransaction

• transaction<T>(callback: (trx: Transaction) => Promise<T>): Promise<T>

  Type Parameters

  • T

  Parameters

  • callback: (trx: Transaction) => Promise<T>

  Returns Promise<T>

• transaction<T>(
      trxOrKnex: TransactionOrKnex | undefined,
      callback: (trx: Transaction) => Promise<T>,
  ): Promise<T>

  Type Parameters

  • T

  Parameters

  • trxOrKnex: TransactionOrKnex | undefined
  • callback: (trx: Transaction) => Promise<T>

  Returns Promise<T>

Statictraverse

• traverse(models: Model | Model[], traverser: TraverserFunction): void

  Parameters

  • models: Model | Model[]
  • traverser: TraverserFunction

  Returns void

• traverse(
      filterConstructor: typeof Model,
      models: Model | Model[],
      traverser: TraverserFunction,
  ): void

  Parameters

  • filterConstructor: typeof Model
  • models: Model | Model[]
  • traverser: TraverserFunction

  Returns void

StatictraverseAsync

• traverseAsync(
      models: Model | Model[],
      traverser: TraverserFunction,
  ): Promise<void>

  Parameters

  • models: Model | Model[]
  • traverser: TraverserFunction

  Returns Promise<void>

• traverseAsync(
      filterConstructor: typeof Model,
      models: Model | Model[],
      traverser: TraverserFunction,
  ): Promise<void>

  Parameters

  • filterConstructor: typeof Model
  • models: Model | Model[]
  • traverser: TraverserFunction

  Returns Promise<void>