ChatGPT解决这个技术问题 Extra ChatGPT

Change default primary key in Eloquent

Can I change Eloquent model primary key.

I want to set primary key for example admin_id instead of 'id'?

I know I can change table name for model like

protected $table = "admin";

Is there something similar for primary key?


p
phirschybar

Yes

class User extends Eloquent {

    protected $primaryKey = 'admin_id';

}

For anyone else referencing this question, use one of the other answers. $primarykey should be $primaryKey (uppercase letter K) and won't work otherwise.
What if I have more than one fields as primary key?
@bagusflyer You are kidding right ? More than one primary key in one database table?
@bagusflyer Eloquent doesn't support composite keys, but here's a good workaround so you can have $primaryKey = array('key1', 'key1'); github.com/laravel/framework/issues/5517#issuecomment-52996610
Just FYI it looks like in Laravel 5.4 you no longer need set your own PK if it's the same as the model name as it adds it for you (and will error out otherwise).
u
user8555937

If you are wanting to use a composite key (a string)

You need to make sure you set public $incrementing = false otherwise laravel will cast the field to an Integer, giving 0

class User extends Model {

    protected $primaryKey = 'my_string_key';
    public $incrementing = false;

}

I did an override on the primaryKey as a text string col - the value in the collection was correct but when I referenced the col as $results->primary_key it would only return zero although the collection/array showed the correct string - took awhile to track it down when I noticed that the primaryKey was showing as an INT and Incrementable in the Object. Had to set public $incrementing = false.
u
user3186817
class User extends Eloquent {

    protected $primarykey = 'admin_id';

}

but

class User extends Eloquent {

    protected $primaryKey = 'admin_id';

}

note the letter K (capital) on the variable $primaryKey


a
ajtrichards

The primary key variable is case sensitive and must be $primaryKey to work.

Example:

protected $primaryKey = 'your_primary_key_id';

Example within a Model class:

class User extends Eloquent {

    protected $primaryKey = 'your_primary_key_id';

}

Do I still have to add it the the $fillable array?
G
Gammer
class User extends Eloquent {

    protected $primaryKey = 'admin_id';

}

As per Laravel documentation :

Eloquent will also assume that each table has a primary key column named id. You may define a $primaryKey property to override this convention.

In addition, Eloquent assumes that the primary key is an incrementing integer value, which means that by default the primary key will be cast to an int automatically. If you wish to use a non-incrementing or a non-numeric primary key you must set the public $incrementing property on your model to false.


M
Mahmoud Abdelsattar

To assign a primary key you should:

class User extends Eloquent {

    protected $primaryKey = 'admin_id';

}