MySQL : Count result accessible only via ‘$extras’ field

[ad-momo]

Package version

@adonisjs/lucid 21.1.0

Describe the bug

Hello 👋,

For a count('*', alias) query, the result cannot be retrieved directly with the alias. You have to use the $extras field.

Database engine : MySQL 8.0.39 (Homebrew)
OS : macos14.4 (arm64)
MySQL Client NodeJS : mysql2 3.10.3

const users = await db
  .from('users')
  .count('*', 'total')

console.log(users[0].total) // undefined
console.log(users[0].$extras.total) // work correctly 

Thanks 😀

Reproduction repo

No response

[dunhamjared]

That is by design.

Any attributes that don't fit into the model will be placed into: $extras

If you want to override this behavior, and have the total with the other attributes on serialization, you could define a custom extras serializer in a model, like so:

export default class Example extends BaseModel {
    
    serializeExtras() {
        return this.$extras
    }

}

Hope this helps!

[thetutlage]

Closing, as nothing needs to be changed in the docs repo for this