Documentation

5.5.3. Data Model’s Primary Key

In this chapter, you’ll learn how to configure the primary key of a data model.

primaryKey Method#

To set any id, text, or number property as a primary key, use the primaryKey method.

For example:

Code
1import { model } from "@medusajs/framework/utils"2
3const MyCustom = model.define("my_custom", {4  id: model.id().primaryKey(),5  // ...6})7
8export default MyCustom

In the example above, the id property is defined as the data model's primary key.

Was this chapter helpful?
Edit this page