cascades Method - DML Reference

This method configures which related data models an operation, such as deletion, should be cascaded to.

For example, if a store is deleted, its product should also be deleted.

Example#

Code
1import { model } from "@medusajs/framework/utils"2
3const Store = model.define("store", {4  id: model.id(),5  products: model.hasMany(() => Product),6})7.cascades({8  delete: ["products"],9})

Parameters#

optionsEntityCascades<ExtractEntityRelations<Schema, "hasOne" | "hasOneWithFK" | "hasMany">, ExtractEntityRelations<Schema, "manyToMany">>

The cascades configurations. They object's keys are the names of the actions, such as deleted, and the value is an array of relations that the action should be cascaded to.