[9.x] UUID and ULID support for Eloquent

[driesvints]

This PR brings UUID & ULID support for Eloquent as primary keys. By simply applying a trait, any Eloquent model will have a UUID or ULID generated as their primary key.

For ULID support, an optional symfony/uid dependency will need to be pulled in.

[X-Coder264]

@driesvints Awesome PR - I was just thinking about using ULIDs in my next project.

Yesterday Symfony added UUID v7 (which is similar to ULID) support (symfony/symfony#47525) to symfony/uid. Would it be possible to add an option to choose whether we want UUID v4 or v7 (as currently Str::orderedUuid() always returns a v4 UUID) ?

[SjorsO]

HasUlidPrimaryKey and HasUuidPrimaryKey might be better names than HasPrimaryUlid and HasPrimaryUuid.

[driesvints]

Yesterday Symfony added UUID v7 (which is similar to ULID) support (symfony/symfony#47525) to symfony/uid. Would it be possible to add an option to choose whether we want UUID v4 or v7 (as currently Str::orderedUuid() always returns a v4 UUID) ?

I'm not sure. We don't use symfony/uid for UUID's but ramsey/uuid. It does not seem that library has support for v7 yet. It also does not seem Str::orderedUuid() has support for specifying the type of UUID so I don't think this is possible?

[driesvints]

HasUlidPrimaryKey and HasUuidPrimaryKey might be better names than HasPrimaryUlid and HasPrimaryUuid.

Done

[DarkGhostHunter]

Shouldn't be blank($model->getKey()) ?

[DarkGhostHunter]

Just came here to say that ULID will be saved into the database as a 26 character string, which occupies 208 bits, almost double than an UUID (128 bit).

If the column is an UUID, most database engines will return an error.

What it could work is setting the key type to "uuid", so then the primary key is detected as an ULID, it will change to RFC4122.

[Jubeki]

Yesterday Symfony added UUID v7 (which is similar to ULID) support (symfony/symfony#47525) to symfony/uid. Would it be possible to add an option to choose whether we want UUID v4 or v7 (as currently Str::orderedUuid() always returns a v4 UUID) ?

I'm not sure. We don't use symfony/uid for UUID's but ramsey/uuid. It does not seem that library has support for v7 yet. It also does not seem Str::orderedUuid() has support for specifying the type of UUID so I don't think this is possible?

It seems like ramsey/uuid now has support for v7: https://github.com/ramsey/uuid/releases/tag/4.5.0

[driesvints]

I'll look into it 👍

[larskoole]

Maybe creating a ulid() macro for the migrations would be nice too.

Currently I'm adding the following macro to the AppServiceProvicer:

Blueprint::macro('ulid', function (string $column = 'ulid') {
    return $this->addColumn('char', $column, ['length' => 26]);
});

Which enables me to do this in my migrations:

Schema::create('users', function (Blueprint $table) {
    $table->ulid('id')->primary();
    ...
});

[tomb1n0]

Awesome! Just this week i'd created a trait that used Str::orderedUuid() exactly like this. Great to have this officially supported inside Laravel

[driesvints]

@larskoole I'll also check into that.

[mariomarquesdev]

@driesvints Could we have an option to set which column to be the uuid?

For example, we could keep the default behaviour of looking at the primary key but it would be nice to have something like getUuidColumn function or something like that inside each Model to override that default behaviour.

Potential usage:

table: users
id (auto increment to be used for relations) | uuid

[larskoole]

@driesvints Could we have an option to set which column to be the uuid?

For example, we could keep the default behaviour of looking at the primary key but it would be nice to have something like getUuidColumn function or something like that inside each Model to override that default behaviour.

Potential usage:

table: users id (auto increment to be used for relations) | uuid

Already there, you can override the uniqueIds() method from the trait inside of your model.

https://github.com/laravel/framework/pull/44074/files#diff-0dbc036e590312e780e3fac6936e57aa9628b31679dd979e098cd73fc34d85cfR35-R43

[BrandonSurowiec]

If someone wanted to use this for columns other than the primary id and updates uniqueIds() to not contain the primary key, the getKeyType() and getIncrementing() shouldn't be overriding $this->keyType and $this->incrementing. We'll need to PR a fix for that.

[driesvints]

If someone wanted to use this for columns other than the primary id and updates uniqueIds() to not contain the primary key, the getKeyType() and getIncrementing() shouldn't be overriding $this->keyType and $this->incrementing. We'll need to PR a fix for that.

I'll think about that a bit more as well.

[driesvints]

Worked on some of the above stuff here: #44146. I'll check into UUID v7 support later.

[tanthammar]

Is there something wrong with the requirement?
I had to manually composer require symfony/uid to get Str::ulid() to work.

[rodrigopedra]

It is in the suggests session. So to use its functionality you should manually install this dependency.

[driesvints]

I sent in a PR to use uuid v7 in Laravel v10 here: #44210

[martio]

@driesvints @taylorotwell I added missing morphs methods for ULID support 👉 PR 44364 😊

[driesvints]

We reverted the changes to make UUID v7 the default in Laravel v10. Please see #44210