UUID Primary Key

[mohux]

I'm using AdonisJS v5 and not v4
when i use User.create()

and add @beforeCreate hook to create a uuid
it returns 0 instead of the stored uuid

therefore the solution of adding
static async get increments(){}
does not work

I tried so many things to fix the issue
but it always return 0

[RomainLanz]

Hey @mohux! 👋

There's no increments method inside the Lucid Model.
Also, if you are using PostgreSQL I'd recommend you to directly use the function uuid_generate_v4() as default instead of generating the uuid yourself.

[mohux]

am using mySQL, and in V5 the uuid is stored correctly in the DB, its just that the model returns 0 when I save the model
if I rename "id" to anything else and keep it as primary, it works for some reason

[fnoquiq]

This post worked for me

https://forum.adonisjs.com/t/how-to-use-uuid-as-primary-key-postgre/3918

[mohux]

Hello, thanks for replaying, this didnt work for me on adonis5

the issue is weird, it happens when i use my primary key as uuid and name it "id"

if i name it "user_id" it returns the stored one
btw even when it returns 0, it stores the uuid correctly in the database
its just the returned value

[mohux]

I figured out that the problem is of how Lucid treats primaryKey via @column({isPrimary:true})
it treats it as increments by default even if your migration is uuid
still cant find a way to solve it,

[RomainLanz]

We cannot help you more with the amount of information you shared.
I'm using UUID in all of my project with no change to my model.

[mohux]

If your using V5

and write this

and inside the model I do the following

then i create a user with create method

the returned user has id = 0

i was able to solve it by doing so

but not sure if its the correct way

[thetutlage]

Lemme check with Mysql

[mohux]

if I use my crazy solution
the find method won't return the ID 😢

[mohux]

it works perfectly now

but pretty sure it isn't the meant solution

[mohammadou1]

Did anyone find a solution? i tried it with PostgreSQL, its working so perfectly, without the need to use consume function

[dajpes]

I'm also using Mysql(MariaDb), and I use the beforeCreate hook in order to add an uuid:

import { v4 as uuidv4 } from "uuid";

export default class User extends BaseModel {

 @beforeCreate()
  public static async addUidHook(user: User) {
    user.uid = uuidv4();
  }

...

  @column({ isPrimary: true, columnName: "uid" })
  public uid: string;
}

[BenCherif]

@mohux i've used refresh() function after create the object " await user.refresh()" then get the id correctly
@dajpes your answer is working for me thank u .

[solnsumei]

@mohux i've user refresh() function after create the object " await user.refresh()" then get the id correctly
@dajpes your answer is working for me thank u .

If you refresh, adonis returns a random data

[BenCherif]

@mohux i've user refresh() function after create the object " await user.refresh()" then get the id correctly
@dajpes your answer is working for me thank u .

If you refresh, adonis returns a random data

you are right ,so i generate a random uuidv4() and i put it to the object so when object has been created i fetch it by id that i've generated before creation . i didn't find a better way :/

[juni0r]

If you use Postgres, there's a clean DRY way to add UUID primary keys with auto-generated IDs (no @beforeCreate)

1. Enable the UUID extension (migration must precede any models using UUIDs)

import BaseSchema from '@ioc:Adonis/Lucid/Schema'

export default class extends BaseSchema {
  public up() {
    this.schema.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"')
  }

  public down() {
    this.schema.raw('DROP EXTENSION IF EXISTS "uuid-ossp"')
  }
}

2. Create migrations for your models

import BaseSchema from '@ioc:Adonis/Lucid/Schema'

export default class extends BaseSchema {
  protected tableName = 'my_model'

  public async up() {
    this.schema.createTable(this.tableName, (table) => {
     // use Postgres builtin function 'uuid_generate_v4' to auto-generate an id
      table.uuid('id').primary().defaultTo(this.raw('uuid_generate_v4()'))

     // more columns…
    })
  }

  // …
}

3. Define your model class

export default class MyModel extends BaseModel {
  @column({ isPrimary: true })
  public id: string

  // ...
}

Refer to primary uuid columns in related models:

export default class extends BaseSchema {
  public async up() {
    this.schema.createTable('my_related_model', (table) => {
      // …
      table.uuid('my_model_id').references('id').inTable('my_model').onDelete('CASCADE')
      // …
    })
  }
}

[McSneaky]

One additional thing I'd suggest to do, is to add uuid-ossp to pg_catalog

It makes dealing with backups, restores and clones lil-bit easier. Otherwise you might end up in situations where you want to clone database within same server, but suddenly uuid extension is not installed, since it was only added to specific database. Adding it to pg_catalog adds it to future clones too (and new databases, have to keep that in mind, you might not want it enabled in new DBs for some reason)

this.schema.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"')

Becomes

this.schema.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp" schema pg_catalog version "1.1";')

[Forthtilliath]

Here my solution, since previews code didn't worked for me on adonis 6.

Insert uuid from model

export default class User extends compose(BaseModel, AuthFinder) {
  static selfAssignPrimaryKey = true

  @column({ isPrimary: true })
  declare id: string

  @beforeCreate()
  static async setId(user: User) {
    user.id = crypto.randomUUID()
   }
}

Solution 2 : insert uuid from schema Not working !

this.schema.createTable(this.tableName, (table) => {
   table.uuid('id').primary().defaultTo(crypto.randomUUID())
})

[RomainLanz]

this.schema.createTable(this.tableName, (table) => {
   table.uuid('id').primary().defaultTo(crypto.randomUUID())
})

This code will not work. You have to define the PSQL function to use it. In your example, you are defining a static value computed when the migration runs to be your default value.

[Forthtilliath]

You're alright. I checked after only one new user...

[vitorabner]

Another solution using preload:

node ace make:preload hooks

hooks.ts

import { BaseModel } from '@adonisjs/lucid/orm'

const boot = BaseModel.boot

BaseModel.boot = function () {
  if (this.booted) return

  boot.call(this)

  this.before('create', (item) => {
    item.$setAttribute('id', crypto.randomUUID())
  })
}

This code will run for every model.