How do I specify the fields on either side of a hasOne/hasMany relationship

[simonjcarr]

The last time I used Adonis was V4, and obviously a lot of things have changed in V5.

I am having problems querying what seems like a pretty simple relationship. I think the issue is I need to specify the name of the fields on either side of the relationship.

I have Two models

User and Doc

Here is the code for them

Doc Model

import { DateTime } from 'luxon'
import { BaseModel, column, hasOne, HasOne } from '@ioc:Adonis/Lucid/Orm'
import User from './User'

export default class Doc extends BaseModel {
  @hasOne(() => User)
  public assignedToUser: HasOne<typeof User>

  @hasOne(() => User)
  public assignedByUser: HasOne<typeof User>

  @hasOne(() => User)
  public approvedByUser: HasOne<typeof User>

  @column()
  public assigned_to: number

  @column()
  public assigned_by: number

  @column()
  public approved_by: number

  @column({ isPrimary: true })
  public id: number

  @column()
  public title: string

  @column()
  public link_url: string

  @column()
  public documentation: string

  @column()
  public approved_date: DateTime

  @column()
  public approval_comment: string

  @column()
  public use_for_build_doc: number

  @column()
  public build_doc_title: string

  @column()
  public build_doc_link_url: string

  @column()
  public build_doc_documentation: string


  @column.dateTime({ autoCreate: true })
  public createdAt: DateTime

  @column.dateTime({ autoCreate: true, autoUpdate: true })
  public updatedAt: DateTime
}

User Model

import { DateTime } from 'luxon'
import { BaseModel, column, HasMany, hasMany } from '@ioc:Adonis/Lucid/Orm'
import Doc from './Doc'
export default class User extends BaseModel {
  @hasMany(() => Doc)
  public assignedToDocs: HasMany<typeof Doc>

  @hasMany(() => Doc)
  public assignedByDocs: HasMany<typeof Doc>

  @hasMany(() => Doc)
  public approvedByDocs: HasMany<typeof Doc>
  
  @column({ isPrimary: true })
  public id: number

  @column()
  public first_name: string

  @column()
  public last_name: string

  @column()
  public email: string

  @column.dateTime({ autoCreate: true })
  public createdAt: DateTime

  @column.dateTime({ autoCreate: true, autoUpdate: true })
  public updatedAt: DateTime
}

Controller with the query I am having problems with

export default class DocsController {
    public async index({ response }: HttpContextContract) {
        const user = await User.findOrFail(1)
        const docs = await Doc.query().preload('assignedToUser').preload('assignedByUser').preload('approvedByUser')
        docs.forEach((doc) => {
            console.log(doc.assignedToUser)
            console.log(doc.assignedByUser)
            console.log(doc.approvedByUser)
        })
        return response.json(docs);
    }

}

The above query gives me the following error

[04:55:47.345] ERROR (adonisapp/304027): E_MISSING_MODEL_ATTRIBUTE: "Doc.assignedToUser" expects "docId" to exist on "User" model, but is missing
    err: {
      "type": "Exception",
      "message": "E_MISSING_MODEL_ATTRIBUTE: \"Doc.assignedToUser\" expects \"docId\" to exist on \"User\" model, but is missing",
      "stack":
          Exception: E_MISSING_MODEL_ATTRIBUTE: "Doc.assignedToUser" expects "docId" to exist on "User" model, but is missing
              at /workspaces/projmon-api/node_modules/@adonisjs/lucid/build/src/Orm/Relations/KeysExtractor.js:47:23
              at Array.reduce (<anonymous>)
              at KeysExtractor.extract (/workspaces/projmon-api/node_modules/@adonisjs/lucid/build/src/Orm/Relations/KeysExtractor.js:43:39)
              at HasOne.boot (/workspaces/projmon-api/node_modules/@adonisjs/lucid/build/src/Orm/Relations/HasOne/index.js:135:12)
              at Preloader.load (/workspaces/projmon-api/node_modules/@adonisjs/lucid/build/src/Orm/Preloader/index.js:106:18)
              at ModelQueryBuilder.preload (/workspaces/projmon-api/node_modules/@adonisjs/lucid/build/src/Orm/QueryBuilder/index.js:567:24)
              at DocsController.index (/workspaces/projmon-api/app/Controllers/Http/DocsController.ts:21:40)
              at processTicksAndRejections (node:internal/process/task_queues:95:5)
              at Object.PreCompiler.runRouteHandler [as fn] (/workspaces/projmon-api/node_modules/@adonisjs/http-server/build/src/Server/PreCompiler/index.js:47:31)
              at Server.handleRequest (/workspaces/projmon-api/node_modules/@adonisjs/http-server/build/src/Server/index.js:108:13)
    }

The error E_MISSING_MODEL_ATTRIBUTE: "Doc.assignedToUser" expects "docId" to exist on "User" means I am obviously doing something wrong in how I am linking my relationships, I assume I must somehow be able to name what field in the other Model a relationship links to. But How?

I want the following relationships to exist

Doc.assignedToUser => User.assignedToDocs
Doc.assignedByUser => User.assignedByDocs
Doc.approvedByUser => User.approvedByDocs

[simonjcarr]

I solve the issue with the following additions to my relationships in each model

Doc Model

@hasOne(() => User, {
    localKey: 'assigned_to',
    foreignKey: 'id'
  })
  public assignedToUser: HasOne<typeof User>

  @hasOne(() => User, {
    localKey: 'assigned_by',
    foreignKey: 'id'
  })
  public assignedByUser: HasOne<typeof User>

  @hasOne(() => User, {
    localKey: 'approved_by',
    foreignKey: 'id'
  })
  public approvedByUser: HasOne<typeof User>

User Model

@hasMany(() => Doc, {
    foreignKey: 'assigned_to'
  })
  public assignedToDocs: HasMany<typeof Doc>

  @hasMany(() => Doc, {
    foreignKey: 'assigned_by'
  })
  public assignedByDocs: HasMany<typeof Doc>

  @hasMany(() => Doc, {
    foreignKey: 'approved_by'
  })
```

[WeyIin]

This is the correct way. :)