feature: add db:create command

[thetutlage]

FIXES: FRMW-2664

This PR introduces a new command called db:create. The command is meant to create the database (if it is missing) and update the .env file after the operation has been successful.

Important

This command does not boot the application nor read the medusa-config.js file. The db:create command should work regardless of the state of the application. Otherwise, we might run into issues where a loader wants to establish the DB connection, but the database does not exist.

How it works?

This is how the command works under the hood.

• The command reads the .env file using the EnvEditor and looks for DATABASE_URL and DB_NAME environment variables.
• The command will exit if the DATABASE_URL is missing. We need the DATABASE_URL to make the database connection.
• The user is prompted to specify the database name with a default value. The default value is set to the DB_NAME environment variable and falls back to the project directory name.
• Finally, taking all this info. The following steps are performed.
  • Establish a connection with the database server.
  • Check if the database already exists
  • If not, create the database
  • Update the .env file.

Newly introduced utilities

The following utilities have been introduced to the @medusajs/utils package.

EnvEditor

It reads the .env file as a text file and exposes the API to edit the values inside it and persist them on the disk.

parseConnectionString

We need to parse the PG connection string and convert it into an object to safely remove the database name from the DATABASE_URL value. We need to remove the database name because we want to establish the connection without selecting this database since it might not exist in the first place.

createClient

Creates the PostgreSQL client instance (Not the Mikro ORM)

createDb

Creates the database

dbExists

Check if the database exists.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 35b8b0f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
medusa-dashboard	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 26, 2024 9:21am

6 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
api-reference	⬜️ Ignored (Inspect)			Aug 26, 2024 9:21am
api-reference-v2	⬜️ Ignored (Inspect)	Visit Preview		Aug 26, 2024 9:21am
docs-ui	⬜️ Ignored (Inspect)	Visit Preview		Aug 26, 2024 9:21am
docs-v2	⬜️ Ignored (Inspect)	Visit Preview		Aug 26, 2024 9:21am
medusa-docs	⬜️ Ignored (Inspect)	Visit Preview		Aug 26, 2024 9:21am
resources-docs	⬜️ Ignored (Inspect)	Visit Preview		Aug 26, 2024 9:21am

[olivermrbl]

Clean PR, LGTM