feature: add db:create command (#8760)

2024-08-26 15:04:52 +05:30
parent cd4063de74
commit 7c2cfc132a
9 changed files with 396 additions and 1 deletions
@@ -0,0 +1,111 @@
+import slugify from "slugify"
+import { basename } from "path"
+import input from "@inquirer/input"
+import { logger } from "@medusajs/framework"
+import {
+  createDb,
+  dbExists,
+  EnvEditor,
+  createClient,
+  parseConnectionString,
+} from "@medusajs/utils"
+
+const main = async function ({ directory, interactive, db }) {
+  let dbName = db
+
+  /**
+   * Loading the ".env" file in editor mode so that
+   * we can read values from it and update its
+   * contents.
+   */
+  const envEditor = new EnvEditor(directory)
+  await envEditor.load()
+
+  /**
+   * Ensure the "DATABASE_URL" is defined before we attempt to
+   * create the database.
+   *
+   * Also we will discard the database name from the connection
+   * string because the mentioned database might not exist
+   */
+  const dbConnectionString = envEditor.get("DATABASE_URL")
+  if (!dbConnectionString) {
+    logger.error(
+      `Missing "DATABASE_URL" inside the .env file. The value is required to connect to the PostgreSQL server`
+    )
+    process.exitCode = 1
+    return
+  }
+
+  /**
+   * Use default value + prompt only when the dbName is not
+   * provided via a flag
+   */
+  if (!dbName) {
+    const defaultValue =
+      envEditor.get("DB_NAME") ?? `medusa-${slugify(basename(directory))}`
+    if (interactive) {
+      try {
+        dbName = await input({
+          message: "Enter the database name",
+          default: defaultValue,
+          required: true,
+        })
+      } catch (error) {
+        if (error.name === "ExitPromptError") {
+          process.exit()
+        }
+        throw error
+      }
+    } else {
+      dbName = defaultValue
+    }
+  }
+
+  /**
+   * Parse connection string specified as "DATABASE_URL" inside the
+   * .env file and create a client instance from it.
+   *
+   * Remember we should not specify the database name from the
+   * connection string, because this database might not
+   * exist
+   */
+  const connectionOptions = parseConnectionString(dbConnectionString)
+  const client = createClient({
+    host: connectionOptions.host!,
+    port: connectionOptions.port ? Number(connectionOptions.port) : undefined,
+    user: connectionOptions.user,
+    password: connectionOptions.password,
+  })
+
+  try {
+    await client.connect()
+    logger.info(`Connection established with the database "${dbName}"`)
+  } catch (error) {
+    process.exitCode = 1
+    logger.error(
+      "Unable to establish database connection because of the following error"
+    )
+    logger.error(error)
+    return
+  }
+
+  if (await dbExists(client, dbName)) {
+    logger.info(`Database "${dbName}" already exists`)
+
+    envEditor.set("DB_NAME", dbName)
+    await envEditor.save()
+    logger.info(`Updated .env file with "DB_NAME=${dbName}"`)
+
+    return
+  }
+
+  await createDb(client, dbName)
+  logger.info(`Created database "${dbName}"`)
+
+  envEditor.set("DB_NAME", dbName)
+  await envEditor.save()
+  logger.info(`Updated .env file with "DB_NAME=${dbName}"`)
+}
+
+export default main