primaryKeys()

Signature

primaryKeys() — returns string

Available in: model Category: Miscellaneous Functions

Description

Alias for primaryKey(). Use this for better readability when you’re accessing multiple primary keys.

Parameters

Name	Type	Required	Default	Description
position	numeric	no	0	If you are accessing a composite primary key, pass the position of a single key to fetch.

Examples

// 1. Get the name(s) of the primary key(s) for the User model (returns a comma-separated list for composite keys)
keyNames = model("User").primaryKeys();
// keyNames -> "id"

// 2. Get the name of the first primary key in a model that uses a composite primary key (e.g., an OrderItem table keyed on orderId,productId)
firstKey = model("OrderItem").primaryKeys(1);
// firstKey -> "orderId"

// 3. Get the second primary key in a composite key model
secondKey = model("OrderItem").primaryKeys(2);
// secondKey -> "productId"