You are viewing documentation for v1.1.x. Change

primaryKey()

Description

Returns the name of the primary key for this model's table. This is determined through database introspection. If composite primary keys have been used, they will both be returned in a list. This function is also aliased as primaryKeys().

Function Syntax

primaryKey([ position ])

Parameters

Parameter 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

<!--- Get the name of the primary key of the table mapped to the `employee` model (which is the `employees` table by default) --->
<cfset keyName = model("employee").primaryKey()>