feat: execute db commands on running instance (#8002)

Author: paulo

package-lock.json

@@ -64,7 +64,7 @@
     "@netlify/build": "35.8.7",
     "@netlify/build-info": "10.3.1",
     "@netlify/config": "24.4.3",
-    "@netlify/dev": "4.15.0",
+    "@netlify/dev": "4.16.0",
     "@netlify/dev-utils": "4.4.0",
     "@netlify/edge-bundler": "14.9.14",
     "@netlify/edge-functions": "3.0.3",
@@ -138,6 +138,7 @@
     "p-map": "7.0.3",
     "p-wait-for": "6.0.0",
     "parallel-transform": "1.2.0",
+    "pg": "^8.11.0",
     "parse-github-url": "1.0.3",
     "prettyjson": "1.2.5",
     "raw-body": "3.0.1",
@@ -182,6 +183,7 @@
     "@types/node": "22.18.11",
     "@types/node-fetch": "2.6.13",
     "@types/parallel-transform": "1.1.4",
+    "@types/pg": "^8.11.0",
     "@types/parse-github-url": "1.0.3",
     "@types/picomatch": "4.0.2",
     "@types/prettyjson": "0.0.33",

package.json

@@ -0,0 +1,54 @@
+import { Client } from 'pg'
+
+import type { SQLExecutor } from '@netlify/dev'
+import { NetlifyDev } from '@netlify/dev'
+import { LocalState } from '@netlify/dev-utils'
+
+import { PgClientExecutor } from './pg-client-executor.js'
+
+interface DBConnection {
+  executor: SQLExecutor
+  cleanup: () => Promise<void>
+}
+
+export async function connectToDatabase(buildDir: string): Promise<DBConnection> {
+  const state = new LocalState(buildDir)
+  const connectionString = state.get('dbConnectionString')
+
+  if (connectionString) {
+    const client = new Client({ connectionString })
+    await client.connect()
+    return {
+      executor: new PgClientExecutor(client),
+      cleanup: () => client.end(),
+    }
+  }
+
+  const netlifyDev = new NetlifyDev({
+    projectRoot: buildDir,
+    aiGateway: { enabled: false },
+    blobs: { enabled: false },
+    edgeFunctions: { enabled: false },
+    environmentVariables: { enabled: false },
+    functions: { enabled: false },
+    geolocation: { enabled: false },
+    headers: { enabled: false },
+    images: { enabled: false },
+    redirects: { enabled: false },
+    staticFiles: { enabled: false },
+    serverAddress: null,
+  })
+
+  await netlifyDev.start()
+
+  const { db } = netlifyDev
+  if (!db) {
+    await netlifyDev.stop()
+    throw new Error('Local database failed to start. Set EXPERIMENTAL_NETLIFY_DB_ENABLED=1 to enable.')
+  }
+
+  return {
+    executor: db,
+    cleanup: () => netlifyDev.stop(),
+  }
+}

src/commands/database/db-connection.ts

@@ -1,7 +1,8 @@
-import { NetlifyDev } from '@netlify/dev'
+import { applyMigrations } from '@netlify/dev'
 
 import { log, logJson } from '../../utils/command-helpers.js'
 import BaseCommand from '../base-command.js'
+import { connectToDatabase } from './db-connection.js'
 
 export interface MigrateOptions {
   to?: string
@@ -22,30 +23,10 @@ export const migrate = async (options: MigrateOptions, command: BaseCommand) =>
     )
   }
 
-  const netlifyDev = new NetlifyDev({
-    projectRoot: buildDir,
-    aiGateway: { enabled: false },
-    blobs: { enabled: false },
-    edgeFunctions: { enabled: false },
-    environmentVariables: { enabled: false },
-    functions: { enabled: false },
-    geolocation: { enabled: false },
-    headers: { enabled: false },
-    images: { enabled: false },
-    redirects: { enabled: false },
-    staticFiles: { enabled: false },
-    serverAddress: null,
-  })
+  const { executor, cleanup } = await connectToDatabase(buildDir)
 
   try {
-    await netlifyDev.start()
-
-    const { db } = netlifyDev
-    if (!db) {
-      throw new Error('Local database failed to start. Set EXPERIMENTAL_NETLIFY_DB_ENABLED=1 to enable.')
-    }
-
-    const applied = await db.applyMigrations(migrationsDirectory, name)
+    const applied = await applyMigrations(executor, migrationsDirectory, name)
 
     if (json) {
       logJson({ migrations_applied: applied })
@@ -58,6 +39,6 @@ export const migrate = async (options: MigrateOptions, command: BaseCommand) =>
       }
     }
   } finally {
-    await netlifyDev.stop()
+    await cleanup()
   }
 }