feat(db-postgres, db-vercel-postgres): createDatabase, auto database create if it does not exist (#8655)

r1tsuu · web-flow · commit 256949e33161 · 2024-10-11T14:17:32.000Z
Adds `createDatabase` method to Postgres adapters which can be used either independently like this: ```ts payload.db.createDatabase({ name: "some-database", schemaName: "custom-schema" }) ``` Or ```ts payload.db.createDatabase() ``` Which creates a database from the current configuration, this is used in `connect` if `autoDatabaseCreate` is set to `true` (default). You can disable this behaviour with: ```ts postgresAdapter({ autoDatabaseCreate: false }) ``` Example: <img width="470" alt="image" src="https://github.com/user-attachments/assets/8d08c79d-9672-454c-af0f-eb802f9dcd99">
diff --git a/docs/database/postgres.mdx b/docs/database/postgres.mdx
@@ -60,6 +60,7 @@ export default buildConfig({
 | `schemaName` (experimental) | A string for the postgres schema to use, defaults to 'public'.                                                                                                                   |
 | `idType`                    | A string of 'serial', or 'uuid' that is used for the data type given to id columns.                                                                                              |
 | `transactionOptions`        | A PgTransactionConfig object for transactions, or set to `false` to disable using transactions. [More details](https://orm.drizzle.team/docs/transactions)                       |
+| `disableCreateDatabase`     | Pass `true` to disale auto database creation if it doesn't exist. Defaults to `false`.                                                                                           |
 | `localesSuffix`             | A string appended to the end of table names for storing localized fields. Default is '_locales'.                                                                                 |
 | `relationshipsSuffix`       | A string appended to the end of table names for storing relationships. Default is '_rels'.                                                                                       |
 | `versionsSuffix`            | A string appended to the end of table names for storing versions. Defaults to '_v'.                                                                                              |
diff --git a/packages/db-postgres/src/connect.ts b/packages/db-postgres/src/connect.ts
@@ -76,7 +76,21 @@ export const connect: Connect = async function connect(
       }
     }
   } catch (err) {
-    this.payload.logger.error({ err, msg: `Error: cannot connect to Postgres: ${err.message}` })
+    if (err.message?.match(/database .* does not exist/i) && !this.disableCreateDatabase) {
+      // capitalize first char of the err msg
+      this.payload.logger.info(
+        `${err.message.charAt(0).toUpperCase() + err.message.slice(1)}, creating...`,
+      )
+      const isCreated = await this.createDatabase()
+
+      if (isCreated) {
+        await this.connect(options)
+        return
+      }
+    } else {
+      this.payload.logger.error(`Error: cannot connect to Postgres. Details: ${err.message}`, err)
+    }
+
     if (typeof this.rejectInitializing === 'function') {
       this.rejectInitializing()
     }
diff --git a/packages/db-postgres/src/index.ts b/packages/db-postgres/src/index.ts
@@ -35,6 +35,7 @@ import {
 import {
   convertPathToJSONTraversal,
   countDistinct,
+  createDatabase,
   createJSONQuery,
   createMigration,
   defaultDrizzleSnapshot,
@@ -78,7 +79,9 @@ export function postgresAdapter(args: Args): DatabaseAdapterObj<PostgresAdapter>
       name: 'postgres',
       afterSchemaInit: args.afterSchemaInit ?? [],
       beforeSchemaInit: args.beforeSchemaInit ?? [],
+      createDatabase,
       defaultDrizzleSnapshot,
+      disableCreateDatabase: args.disableCreateDatabase ?? false,
       drizzle: undefined,
       enums: {},
       features: {
diff --git a/packages/db-postgres/src/types.ts b/packages/db-postgres/src/types.ts
@@ -24,6 +24,11 @@ export type Args = {
    * To generate Drizzle schema from the database, see [Drizzle Kit introspection](https://orm.drizzle.team/kit-docs/commands#introspect--pull)
    */
   beforeSchemaInit?: PostgresSchemaHook[]
+  /**
+   * Pass `true` to disale auto database creation if it doesn't exist.
+   * @default false
+   */
+  disableCreateDatabase?: boolean
   idType?: 'serial' | 'uuid'
   localesSuffix?: string
   logger?: DrizzleConfig['logger']
diff --git a/packages/db-vercel-postgres/src/connect.ts b/packages/db-vercel-postgres/src/connect.ts
@@ -39,7 +39,21 @@ export const connect: Connect = async function connect(
       }
     }
   } catch (err) {
-    this.payload.logger.error({ err, msg: `Error: cannot connect to Postgres: ${err.message}` })
+    if (err.message?.match(/database .* does not exist/i) && !this.disableCreateDatabase) {
+      // capitalize first char of the err msg
+      this.payload.logger.info(
+        `${err.message.charAt(0).toUpperCase() + err.message.slice(1)}, creating...`,
+      )
+      const isCreated = await this.createDatabase()
+
+      if (isCreated) {
+        await this.connect(options)
+        return
+      }
+    } else {
+      this.payload.logger.error(`Error: cannot connect to Postgres. Details: ${err.message}`, err)
+    }
+
     if (typeof this.rejectInitializing === 'function') {
       this.rejectInitializing()
     }
diff --git a/packages/db-vercel-postgres/src/index.ts b/packages/db-vercel-postgres/src/index.ts
@@ -35,6 +35,7 @@ import {
 import {
   convertPathToJSONTraversal,
   countDistinct,
+  createDatabase,
   createJSONQuery,
   createMigration,
   defaultDrizzleSnapshot,
@@ -78,7 +79,9 @@ export function vercelPostgresAdapter(args: Args = {}): DatabaseAdapterObj<Verce
       name: 'postgres',
       afterSchemaInit: args.afterSchemaInit ?? [],
       beforeSchemaInit: args.beforeSchemaInit ?? [],
+      createDatabase,
       defaultDrizzleSnapshot,
+      disableCreateDatabase: args.disableCreateDatabase ?? false,
       drizzle: undefined,
       enums: {},
       features: {
diff --git a/packages/db-vercel-postgres/src/types.ts b/packages/db-vercel-postgres/src/types.ts
@@ -25,6 +25,11 @@ export type Args = {
    */
   beforeSchemaInit?: PostgresSchemaHook[]
   connectionString?: string
+  /**
+   * Pass `true` to disale auto database creation if it doesn't exist.
+   * @default false
+   */
+  disableCreateDatabase?: boolean
   idType?: 'serial' | 'uuid'
   localesSuffix?: string
   logger?: DrizzleConfig['logger']
diff --git a/packages/drizzle/src/exports/postgres.ts b/packages/drizzle/src/exports/postgres.ts
@@ -1,4 +1,5 @@
 export { countDistinct } from '../postgres/countDistinct.js'
+export { createDatabase } from '../postgres/createDatabase.js'
 export { convertPathToJSONTraversal } from '../postgres/createJSONQuery/convertPathToJSONTraversal.js'
 export { createJSONQuery } from '../postgres/createJSONQuery/index.js'
 export { createMigration } from '../postgres/createMigration.js'
diff --git a/packages/drizzle/src/postgres/createDatabase.ts b/packages/drizzle/src/postgres/createDatabase.ts
@@ -0,0 +1,110 @@
+import type { ClientConfig } from 'pg'
+
+import type { BasePostgresAdapter } from './types.js'
+
+const setConnectionStringDatabase = ({
+  connectionString,
+  database,
+}: {
+  connectionString: string
+  database: string
+}): string => {
+  const connectionURL = new URL(connectionString)
+  const newConnectionURL = new URL(connectionURL)
+  newConnectionURL.pathname = `/${database}`
+
+  return newConnectionURL.toString()
+}
+
+type Args = {
+  /**
+   * Name of a database, defaults to the current one
+   */
+  name?: string
+  /**
+   * Schema to create in addition to 'public'. Defaults to adapter.schemaName if exists.
+   */
+  schemaName?: string
+}
+export const createDatabase = async function (this: BasePostgresAdapter, args: Args = {}) {
+  // DATABASE_URL - default Vercel env
+  const connectionString = this.poolOptions?.connectionString ?? process.env.DATABASE_URL
+  let managementClientConfig: ClientConfig = {}
+  let dbName = args.name
+  const schemaName = this.schemaName || 'public'
+
+  if (connectionString) {
+    if (!dbName) {
+      dbName = new URL(connectionString).pathname.slice(1)
+    }
+
+    managementClientConfig.connectionString = setConnectionStringDatabase({
+      connectionString,
+      database: 'postgres',
+    })
+  } else {
+    if (!dbName) {
+      dbName = this.poolOptions.database
+    }
+
+    managementClientConfig = {
+      ...this.poolOptions,
+      database: 'postgres',
+    }
+  }
+
+  // import pg only when createDatabase is used
+  const pg = await import('pg')
+
+  const managementClient = new pg.Client(managementClientConfig)
+
+  try {
+    await managementClient.connect()
+    await managementClient.query(`CREATE DATABASE ${dbName}`)
+
+    this.payload.logger.info(`Created database "${dbName}"`)
+
+    if (schemaName !== 'public') {
+      let createdDatabaseConfig: ClientConfig = {}
+
+      if (connectionString) {
+        createdDatabaseConfig.connectionString = setConnectionStringDatabase({
+          connectionString,
+          database: dbName,
+        })
+      } else {
+        createdDatabaseConfig = {
+          ...this.poolOptions,
+          database: dbName,
+        }
+      }
+
+      const createdDatabaseClient = new pg.Client(createdDatabaseConfig)
+
+      try {
+        await createdDatabaseClient.connect()
+
+        await createdDatabaseClient.query(`CREATE SCHEMA ${schemaName}`)
+        this.payload.logger.info(`Created schema "${dbName}.${schemaName}"`)
+      } catch (err) {
+        this.payload.logger.error({
+          err,
+          msg: `Error: failed to create schema "${dbName}.${schemaName}". Details: ${err.message}`,
+        })
+      } finally {
+        await createdDatabaseClient.end()
+      }
+    }
+
+    return true
+  } catch (err) {
+    this.payload.logger.error(
+      `Error: failed to create database ${dbName}. Details: ${err.message}`,
+      err,
+    )
+
+    return false
+  } finally {
+    await managementClient.end()
+  }
+}
diff --git a/packages/drizzle/src/postgres/types.ts b/packages/drizzle/src/postgres/types.ts
@@ -21,7 +21,7 @@ import type {
 } from 'drizzle-orm/pg-core'
 import type { PgTableFn } from 'drizzle-orm/pg-core/table'
 import type { Payload, PayloadRequest } from 'payload'
-import type { QueryResult } from 'pg'
+import type { ClientConfig, QueryResult } from 'pg'
 
 import type { extendDrizzleTable, Operators } from '../index.js'
 import type { BuildQueryJoinAliases, DrizzleAdapter, TransactionPg } from '../types.js'
@@ -92,6 +92,17 @@ export type Insert = (args: {
   values: Record<string, unknown> | Record<string, unknown>[]
 }) => Promise<Record<string, unknown>[]>
 
+export type CreateDatabase = (args?: {
+  /**
+   * Name of a database, defaults to the current one
+   */
+  name?: string
+  /**
+   * Schema to create in addition to 'public'. Defaults from adapter.schemaName if exists.
+   */
+  schemaName?: string
+}) => Promise<boolean>
+
 type Schema =
   | {
       enum: typeof pgEnum
@@ -119,8 +130,10 @@ export type BasePostgresAdapter = {
   afterSchemaInit: PostgresSchemaHook[]
   beforeSchemaInit: PostgresSchemaHook[]
   countDistinct: CountDistinct
+  createDatabase: CreateDatabase
   defaultDrizzleSnapshot: DrizzleSnapshotJSON
   deleteWhere: DeleteWhere
+  disableCreateDatabase: boolean
   drizzle: PostgresDB
   dropDatabase: DropDatabase
   enums: Record<string, GenericEnum>
@@ -137,6 +150,7 @@ export type BasePostgresAdapter = {
   logger: DrizzleConfig['logger']
   operators: Operators
   pgSchema?: Schema
+  poolOptions?: ClientConfig
   prodMigrations?: {
     down: (args: MigrateDownArgs) => Promise<void>
     name: string

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`export { countDistinct } from '../postgres/countDistinct.js'`
	`2`	`+export { createDatabase } from '../postgres/createDatabase.js'`
`2`	`3`	`export { convertPathToJSONTraversal } from '../postgres/createJSONQuery/convertPathToJSONTraversal.js'`
`3`	`4`	`export { createJSONQuery } from '../postgres/createJSONQuery/index.js'`
`4`	`5`	`export { createMigration } from '../postgres/createMigration.js'`