Development Resources

db Commands - Medusa CLI Reference

Commands starting with db: perform actions on the database.

db:setup#

Creates a database for the Medusa application with the specified name, if it doesn't exit. Then, it runs migrations and syncs links.

It also updates your .env file with the database name.

Terminal
❯npx medusa db:setup --db <name>

Tip: Use this command if you're setting up a Medusa project or database manually.

Option	Description	Required	Default
`--db <name>`	The database name.	Yes	-
`--skip-links`	Skip syncing links to the database.	No	Links are synced by default.
`--execute-safe-links`	Skip prompts when syncing links and execute only safe actions.	No	Prompts are shown for unsafe actions, by default.
`--execute-all-links`	Skip prompts when syncing links and execute all (including unsafe) actions.	No	Prompts are shown for unsafe actions, by default.
`--no-interactive`	Disable the command's prompts.	No	-

Creates a database for the Medusa application with the specified name, if it doesn't exit.

It also updates your .env file with the database name.

Terminal
❯npx medusa db:create --db <name>

Tip: Use this command if you want to only create a database.

Option	Description	Required	Default
`--db <name>`	The database name.	Yes	-
`--no-interactive`	Disable the command's prompts.	No	-

Generate a migration file for the latest changes in one or more modules.

Terminal
❯npx medusa db:generate <module_names...>

Argument	Description	Required
`module_names`	The name of one or more module (separated by spaces) to generate migrations for. For example, `helloModuleService`.	Yes

Run the latest migrations to reflect changes on the database, and sync link definitions with the database.

Terminal
❯npx medusa db:migrate

Tip: Use this command if you've updated the Medusa packages, or you've created customizations and want to reflect them in the database.

Option	Description	Required	Default
`--skip-links`	Skip syncing links to the database.	No	Links are synced by default.
`--execute-safe-links`	Skip prompts when syncing links and execute only safe actions.	No	Prompts are shown for unsafe actions, by default.
`--execute-all-links`	Skip prompts when syncing links and execute all (including unsafe) actions.	No	Prompts are shown for unsafe actions, by default.

Revert the last migrations ran on one or more modules.

Terminal
❯npx medusa db:rollback <module_names...>

Argument	Description	Required
`module_names`	The name of one or more module (separated by spaces) to rollback their migrations for. For example, `helloModuleService`.	Yes

Sync the database with the link definitions in your application, including the definitions in Medusa's modules.

Terminal
❯npx medusa db:sync-links

Option	Description	Required	Default
`--execute-safe`	Skip prompts when syncing links and execute only safe actions.	No	Prompts are shown for unsafe actions, by default.
`--execute-all`	Skip prompts when syncing links and execute all (including unsafe) actions.	No	Prompts are shown for unsafe actions, by default.

Was this page helpful?