Skip to content

Miscellaneous

setPrimaryKey()

setPrimaryKey() — returns any

Allows you to pass in the name(s) of the property(s) that should be used as the primary key(s). Pass as a list if defining a composite primary key. Also aliased as setPrimaryKeys().

NameTypeRequiredDefaultDescription
propertystringyesProperty (or list of properties) to set as the primary key.
setPrimaryKey(property) <!--- In `models/User.cfc`, define the primary key as a column called `userID` --->
<cffunction name="init">
    <cfset setPrimaryKey("userID")>
</cffunction>