feat: re-structure db commands (#8137)

Author: paulo

src/commands/database/database.ts

@@ -30,55 +30,55 @@ export const createDatabaseCommand = (program: BaseCommand) => {
     .description(`Provision a production ready Postgres database with a single command`)
     .addExamples([
       'netlify db status',
-      'netlify db init',
-      'netlify db init --help',
       ...(process.env.EXPERIMENTAL_NETLIFY_DB_ENABLED === '1'
-        ? ['netlify db migrate', 'netlify db reset', 'netlify db migration new']
-        : []),
+        ? ['netlify db migrations apply', 'netlify db reset', 'netlify db migrations new']
+        : ['netlify db init', 'netlify db init --help']),
     ])
 
-  dbCommand
-    .command('init')
-    .description(`Initialize a new database for the current site`)
-    .option(
-      '--assume-no',
-      'Non-interactive setup. Does not initialize any third-party tools/boilerplate. Ideal for CI environments or AI tools.',
-      false,
-    )
-    .addOption(
-      new Option('--boilerplate <tool>', 'Type of boilerplate to add to your project.').choices(
-        Array.from(supportedBoilerplates).sort(),
-      ),
-    )
-    .option('--no-boilerplate', "Don't add any boilerplate to your project.")
-    .option('-o, --overwrite', 'Overwrites existing files that would be created when setting up boilerplate')
-    .action(async (_options: Record<string, unknown>, command: BaseCommand) => {
-      const { init } = await import('./init.js')
+  if (process.env.EXPERIMENTAL_NETLIFY_DB_ENABLED !== '1') {
+    dbCommand
+      .command('init')
+      .description(`Initialize a new database for the current site`)
+      .option(
+        '--assume-no',
+        'Non-interactive setup. Does not initialize any third-party tools/boilerplate. Ideal for CI environments or AI tools.',
+        false,
+      )
+      .addOption(
+        new Option('--boilerplate <tool>', 'Type of boilerplate to add to your project.').choices(
+          Array.from(supportedBoilerplates).sort(),
+        ),
+      )
+      .option('--no-boilerplate', "Don't add any boilerplate to your project.")
+      .option('-o, --overwrite', 'Overwrites existing files that would be created when setting up boilerplate')
+      .action(async (_options: Record<string, unknown>, command: BaseCommand) => {
+        const { init } = await import('./init.js')
 
-      // Only prompt for drizzle if the user did not specify a boilerplate option, and if we're in
-      // interactive mode
-      if (_options.boilerplate === undefined && !_options.assumeNo) {
-        const answers = await inquirer.prompt<{ useDrizzle: boolean }>([
-          {
-            type: 'confirm',
-            name: 'useDrizzle',
-            message: 'Set up Drizzle boilerplate?',
-          },
-        ])
-        if (answers.useDrizzle) {
-          command.setOptionValue('boilerplate', 'drizzle')
+        // Only prompt for drizzle if the user did not specify a boilerplate option, and if we're in
+        // interactive mode
+        if (_options.boilerplate === undefined && !_options.assumeNo) {
+          const answers = await inquirer.prompt<{ useDrizzle: boolean }>([
+            {
+              type: 'confirm',
+              name: 'useDrizzle',
+              message: 'Set up Drizzle boilerplate?',
+            },
+          ])
+          if (answers.useDrizzle) {
+            command.setOptionValue('boilerplate', 'drizzle')
+          }
         }
-      }
 
-      const options = _options as DatabaseInitOptions
-      if (options.assumeNo) {
-        options.boilerplate = false
-        options.overwrite = false
-      }
+        const options = _options as DatabaseInitOptions
+        if (options.assumeNo) {
+          options.boilerplate = false
+          options.overwrite = false
+        }
 
-      await init(options, command)
-    })
-    .addExamples([`netlify db init --assume-no`, `netlify db init --boilerplate=drizzle --overwrite`])
+        await init(options, command)
+      })
+      .addExamples([`netlify db init --assume-no`, `netlify db init --boilerplate=drizzle --overwrite`])
+  }
 
   dbCommand
     .command('status')
@@ -109,16 +109,6 @@ export const createDatabaseCommand = (program: BaseCommand) => {
         'netlify db connect --json',
       ])
 
-    dbCommand
-      .command('migrate')
-      .description('Apply database migrations to the local development database')
-      .option('--to <name>', 'Target migration name or prefix to apply up to (applies all if omitted)')
-      .option('--json', 'Output result as JSON')
-      .action(async (options: { to?: string; json?: boolean }, command: BaseCommand) => {
-        const { migrate } = await import('./migrate.js')
-        await migrate(options, command)
-      })
-
     dbCommand
       .command('reset')
       .description('Reset the local development database, removing all data and tables')
@@ -128,9 +118,19 @@ export const createDatabaseCommand = (program: BaseCommand) => {
         await reset(options, command)
       })
 
-    const migrationCommand = dbCommand.command('migration').description('Manage database migrations')
+    const migrationsCommand = dbCommand.command('migrations').description('Manage database migrations')
+
+    migrationsCommand
+      .command('apply')
+      .description('Apply database migrations to the local development database')
+      .option('--to <name>', 'Target migration name or prefix to apply up to (applies all if omitted)')
+      .option('--json', 'Output result as JSON')
+      .action(async (options: { to?: string; json?: boolean }, command: BaseCommand) => {
+        const { migrate } = await import('./migrate.js')
+        await migrate(options, command)
+      })
 
-    migrationCommand
+    migrationsCommand
       .command('new')
       .description('Create a new migration')
       .option('-d, --description <description>', 'Purpose of the migration (used to generate the file name)')
@@ -146,8 +146,8 @@ export const createDatabaseCommand = (program: BaseCommand) => {
         await migrationNew(options, command)
       })
       .addExamples([
-        'netlify db migration new',
-        'netlify db migration new --description "add users table" --scheme sequential',
+        'netlify db migrations new',
+        'netlify db migrations new --description "add users table" --scheme sequential',
       ])
   }
 }