This package is abandoned and no longer maintained. The author suggests using the dyrynda/laravel-model-uuid package instead.

A Laravel Eloquent Model trait for adding and using a uuid with models

Installs: 42 814

Dependents: 0

Suggesters: 0

Security: 0

Stars: 139

Watchers: 7

Forks: 15

Open Issues: 6


1.6.1 2020-09-23 15:33 UTC

This package is auto-updated.

Last update: 2022-02-14 03:52:47 UTC


Packagist Packagist Packagist Buy us a tree

A Laravel Eloquent Model trait for adding and using a uuid with models.

The trait listens to the creating event. It generates a new UUID and saves it in the uuid column on the model.

Featured in Laravel News


composer require jamesmills/eloquent-uuid


In order to use this in your models, just put use HasUuidTrait;


namespace App;
use JamesMills\Uuid\HasUuidTrait;

class User extends Eloquent
	use HasUuidTrait;

Schema requirements

In order to use this trait, your schema must be something like:

	// ...
	Schema::create('users', function (Blueprint $table) {
		$table->uuid('uuid')->unique(); // this will create a CHAR(36) field
		$table->string('username', 32);
		$table->string('password', 50);
		// ...

Querying your models

You may use the findByUuidOrFail method to try and fetch a model directly:


Route::get('/user/{uuid}', function($uuid) {
    try {
        return App\User::findByUuidOrFail($uuid);
    } catch (Illuminate\Database\Eloquent\ModelNotFoundException $e) {

Since uuid gets registered as Route Key using implicit binding[https://laravel.com/docs/5.8/routing#implicit-binding], your resource controllers will use uuid instead of default id column.


    php artisan make:controller UserController --resource

/users/{user} route uses uuid i.e. /users/bff37872-1450-47c7-b9f7-9a6d917796cf

You may also use the withUuid and withUuids local query scopes with the query builder.


Route::get('/user/{uuid}', function($uuid) {
    $user = App\User::withUuid($uuid)->first();
    if (! $user) {
        // Do something else...

Route::delete('/users', function(Request $request) {
    // Receive an array of UUIDs
    $uuids = $request->input('uuids');

    // Try to get the Users
    $users = App\User::withUuids($uuids)->all();
    // Handle the delete and return


This package is 100% free and open-source, under the MIT license. Use it however you want.

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.