Get Started
Product
Resources
Tools & SDKs
Framework
Reference

belongsTo Relationship Method - DML Reference

This method defines the inverse of the hasOne or hasMany relationship.

For example, a product "belongsTo" a store.

Example#

Code
1import { model } from "@medusajs/framework/utils"2
3const Product = model.define("product", {4  id: model.id(),5  store: model.belongsTo(() => Store, {6    mappedBy: "products",7  }),8})

Type Parameters#

TobjectOptional

The type of the entity builder passed as a first parameter. By default, it's a function returning the related model.

ForeignKeyNameundefined | stringOptional

Parameters#

entityBuilderT

A function that returns the data model this model is related to.

optionsobject & Record<string, any> & objectOptional

The relationship's options.

Was this page helpful?