feat: optionally disabling schema creation with createSchema option #605

Author: instilled

docs/api/constructor.md

@@ -69,10 +69,13 @@ The following options can be set as properties in an object for additional confi
 
 * **migrate**, bool, default true
 
-  If this is set to false, this instance will skip attempts to run schema migratations during `start()`. If schema migrations exist, `start()` will throw and error and block usage. This is an advanced use case when the configured user account does not have schema mutation privileges.
+  If this is set to false, this instance will skip attempts to run schema migrations during `start()`. If schema migrations exist, `start()` will throw and error and block usage. This is an advanced use case when the configured user account does not have schema mutation privileges.
 
 The following configuration options should not normally need to be changed, but are still available for special use cases.
 
+* **createSchema**, bool, default true
+  If set to false, the migration will not issue a CREATE SCHEMA statement. In some databases (for example, PostgreSQL), executing CREATE SCHEMA can fail even if the schema already exists, when the user lacks the required privileges to create schemas. Disabling this option prevents such errors.
+
 * **superviseIntervalSeconds**, int, default 60 seconds
 
   Entry point for how often queues are monitored and maintained.

src/contractor.js

@@ -5,8 +5,8 @@ const migrationStore = require('./migrationStore')
 const schemaVersion = require('../version.json').schema
 
 class Contractor {
-  static constructionPlans (schema = DEFAULT_SCHEMA) {
-    return plans.create(schema, schemaVersion)
+  static constructionPlans (schema = DEFAULT_SCHEMA, options = { createSchema: true }) {
+    return plans.create(schema, schemaVersion, options)
   }
 
   static migrationPlans (schema = DEFAULT_SCHEMA, version = schemaVersion - 1) {
@@ -69,7 +69,7 @@ class Contractor {
 
   async create () {
     try {
-      const commands = plans.create(this.config.schema, schemaVersion)
+      const commands = plans.create(this.config.schema, schemaVersion, this.config)
       await this.db.executeSql(commands)
     } catch (err) {
       assert(err.message.includes(plans.CREATE_RACE_MESSAGE), err)

src/index.js

@@ -24,8 +24,8 @@ class PgBoss extends EventEmitter {
   #manager
   #timekeeper
 
-  static getConstructionPlans (schema) {
-    return Contractor.constructionPlans(schema)
+  static getConstructionPlans (schema, options = { createSchema: true }) {
+    return Contractor.constructionPlans(schema, options)
   }
 
   static getMigrationPlans (schema, version) {

src/plans.js

@@ -82,9 +82,9 @@ module.exports = {
   DEFAULT_SCHEMA,
 }
 
-function create (schema, version) {
+function create (schema, version, options = { createSchema: true }) {
   const commands = [
-    createSchema(schema),
+    ...(options.createSchema ? [createSchema(schema)] : []),
     createEnumJobState(schema),
 
     createTableVersion(schema),

test/migrationTest.js

@@ -12,6 +12,18 @@ describe('migration', function () {
     this.currentTest.contractor = new Contractor(db, this.currentTest.bossConfig)
   })
 
+  it('should include create schema by default ', function () {
+    const schema = 'custom'
+    const plans = PgBoss.getConstructionPlans(schema)
+    assert(plans.includes('CREATE SCHEMA'))
+  })
+
+  it('should not include create schema if createSchema=false', function () {
+    const schema = 'custom'
+    const plans = PgBoss.getConstructionPlans(schema, { createSchema: false })
+    assert(!plans.includes('CREATE SCHEMA'))
+  })
+
   it('should export commands to manually build schema', function () {
     const schema = 'custom'
     const plans = PgBoss.getConstructionPlans(schema)

types.d.ts

@@ -46,6 +46,7 @@ declare namespace PgBoss {
   interface MaintenanceOptions {
     supervise?: boolean;
     migrate?: boolean;
+    createSchema?: boolean;
     warningSlowQuerySeconds?: number;
     warningQueueSize?: number;
     superviseIntervalSeconds?: number;
@@ -220,7 +221,7 @@ declare class PgBoss extends EventEmitter {
   constructor (connectionString: string)
   constructor (options: PgBoss.ConstructorOptions)
 
-  static getConstructionPlans (schema?: string): string
+  static getConstructionPlans (schema?: string, options?: { createSchema: boolean }): string
   static getMigrationPlans (schema?: string, version?: string): string
   static getRollbackPlans (schema?: string, version?: string): string