add ensureSchemaExists to config schema

Signed-off-by: Chap Ambrose <cambrose@salesforce.com>
2024-05-02 08:22:18 -05:00
parent 0b8b8e80c8
commit 8e9727b825
1 changed files with 14 additions and 0 deletions
@@ -111,6 +111,13 @@ export interface Config {
       * Defaults to true if unspecified.
       */
      ensureExists?: boolean;
+      /**
+       * Whether to ensure the given database schema exists by creating it if it does not.
+       * Defaults to false if unspecified.
+       *
+       * * NOTE: Currently only supported by the `pg` client when pluginDivisionMode: schema
+       */
+      ensureSchemaExists?: boolean;
      /**
       * How plugins databases are managed/divided in the provided database instance.
       *
@@ -147,6 +154,13 @@ export interface Config {
           * Defaults to base config if unspecified.
           */
          ensureExists?: boolean;
+          /**
+           * Whether to ensure the given database schema exists by creating it if it does not.
+           * Defaults to false if unspecified.
+           *
+           * * NOTE: Currently only supported by the `pg` client when pluginDivisionMode: schema
+           */
+          ensureSchemaExists?: boolean;
          /**
           * Arbitrary config object to pass to knex when initializing
           * (https://knexjs.org/#Installation-client). Most notable is the