Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

index Method - API Reference

This method defines an index on a property.

Example#

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

Parameters#

namestringOptional
The index's name. If not provided, Medusa generates the name.
Was this page helpful?