Be Careful: Laravel 5.8 Added bigIncrements As Defaults

There is one change in Laravel 5.8 that is not mentioned in the official Upgrade Guide but caused me problems – I couldn’t create a foreign key migration, and spent half-hour until found out the reasons. So I want to share, maybe you will encounter the same thing.

My Situation Example and Error

While working on one project, I’ve created a simple table transaction_types:

php artisan make:migration create_transaction_types_table

And added just one new string() field:

Schema::create('transactions_types', function (Blueprint $table) {
    $table->bigIncrements('id');
    $table->string('name');
    $table->timestamps();
});

And then tried to create a migration for transactions table with a foreign key, with same syntax I used to do all the time:

php artisan make:migration create_transactions_table

Migration file content:

Schema::create('transactions', function (Blueprint $table) {
    $table->bigIncrements('id');
    $table->integer('transaction_type_id')->unsigned();
    $table->foreign('transaction_type_id')->references('id')->on('transactions_types');
    $table->decimal('amount');
    $table->timestamps();
});

And here’s what happened when running php artisan migrate:

As usual, the error “cannot add foreign key constraint” doesn’t give much details so I was just guessing, what could go wrong:

  • Typo in table name? Double-checked, nope.
  • Too long foreign key name? (should be up to 64 characters) Doesn’t seem so.
  • Mismatch in foreign key field types? Hmmm, then I noticed something…

Look closer at what Laravel is generating when doing php artisan make:migration command:

Schema::create('transactions_types', function (Blueprint $table) {
    $table->bigIncrements('id');
    // ...

bigIncrements. BIG increments. And then, of course, if you’re doing a foreign key from just “unsigned integer” type (as I always did my whole life), it fails. Type mismatch. Obviously.

How to Fix

Well, it’s easy. There are two ways to make it work:

  • Either change original migration from bigIncrements() to just increments();
  • Or in your foreign key column do bigInteger() instead of integer().

The choice is yours.

Why Am I so Angry About It

Simple – this change wasn’t mentioned anywhere in 5.8 changes.

So, it makes me think that probably it’s only me with this problem, and everyone else will actually notice that migrations are being generated with bigIncrements().

After some googling, I’ve found one Reddit thread and one Stackoverflow post about it. That’s it.

Oh, and, of course, it was mentioned and discussed in the official Github repository of Laravel, back in November 2018:

Don’t get me wrong, I’m not against that change to bigIncrements(). I’m just angry about how it was (NOT) communicated. Probably only a bunch of people participating in internal Github communications actually knew about this change.

P.S. Oh, by the way, default users table migration also comes with bigIncrements():

Schema::create('users', function (Blueprint $table) {
    $table->bigIncrements('id');
    $table->string('name');
    $table->string('email')->unique();
    $table->timestamp('email_verified_at')->nullable();
    $table->string('password');
    $table->rememberToken();
    $table->timestamps();
});

So whenever you create new fields with foreign key to users, don’t forget to use bigInteger().

Like our articles?
Check out our Laravel online courses!

RELATED ARTICLESMORE FROM AUTHOR

19 COMMENTS

  1. Just before i saw your tweet I upgraded a package to 5.8 where i have a user_id foreign key in a migration, then i tested it within a new laravel5.8 project and i ran the migrate command but nothing happened it worked, I saw the tweet and I went back and checked again but still no errors, “binIncrements” id against “unsignedInteger” user_id, maybe somehow it fixed

  5. Funny enough. I went for an interview and part I was to develop and app and that was the first time I was working with Laravel 5.8 . I had same error as you and that really wasted my time trying to debug. I think that change should have been communicated.

  8. Shouldn’t the foreign key be specified as a “unsignedBigInteger” since “bigIncrements” reflects a column of type UNSIGNED BIGINT?

  9. Nice article!
    Yesterday took me like 2-3 hours to figure out this. I just started working with laravel 2 weeks ago and I thought I was doing something else wrong..

  10. Hi! It’s nice article! But I didn’t solve this error.
    Illuminate\Database\QueryException : SQLSTATE[HY000]: General error: 1005 Ca
    n’t create table `dbstudent`.`#sql-11c8_1f` (errno: 150 “Foreign key constraint
    is incorrectly formed”) (SQL: alter table `transactions` add constraint `transac
    tions_transaction_type_id_foreign` foreign key (`transaction_type_id`) reference
    s `transactions_types` (`id`))

    at C:\xampp\htdocs\students\vendor\laravel\framework\src\Illuminate\Database\C
    onnection.php:664
    660| // If an exception occurs when attempting to run a query, we’ll
    format the error
    661| // message to include the bindings with SQL, which will make th
    is exception a
    662| // lot more helpful to the developer instead of just the databa
    se’s errors.
    663| catch (Exception $e) {
    > 664| throw new QueryException(
    665| $query, $this->prepareBindings($bindings), $e
    666| );
    667| }
    668|

    Exception trace:

    1 PDOException::(“SQLSTATE[HY000]: General error: 1005 Can’t create table `d
    bstudent`.`#sql-11c8_1f` (errno: 150 “Foreign key constraint is incorrectly form
    ed”)”)
    C:\xampp\htdocs\students\vendor\laravel\framework\src\Illuminate\Database\
    Connection.php:458

    2 PDOStatement::execute()
    C:\xampp\htdocs\students\vendor\laravel\framework\src\Illuminate\Database\
    Connection.php:458

    Please use the argument -v to see more details.
    Scripts:
    public function up()
    {
    Schema::create(‘transactions’, function (Blueprint $table) {
    $table->bigIncrements(‘id’);
    $table->bigInteger(‘transaction_type_id’)->unsigned();
    $table->foreign(‘transaction_type_id’)->references(‘id’)->on(‘transactions_types’);
    $table->decimal(‘amount’);
    $table->timestamps();
    });
    }

    public function up()
    {
    Schema::create(‘transaction_types’, function (Blueprint $table) {
    $table->bigIncrements(‘id’);
    $table->string(‘name’);
    $table->timestamps();
    });
    }

  14. Yes I have faced the same problem when I was creating a migration file which has a foreign key on references
    another table .I have fixed this problem after thirty or thirty five minutes later.
    Thanks for sharing.
    keep it on …

  16. Thanks!! – was pulling hair out – a little embarrassed I did not notice the data type change, but still, if the laravel team is going to make datatype changes it would be nice if they warn people

LEAVE A REPLY

Please enter your comment!
Please enter your name here

Or, you can subscribe without commenting.