@backstage/backend-defaults 0.5.1-next.0 → 0.5.1-next.2

package/dist/entrypoints/database/connectors/mysql.cjs.js

@@ -0,0 +1,278 @@
+'use strict';
+
+var config = require('@backstage/config');
+var errors = require('@backstage/errors');
+var knexFactory = require('knex');
+var lodash = require('lodash');
+var limiterFactory = require('p-limit');
+var yn = require('yn');
+var defaultNameOverride = require('./defaultNameOverride.cjs.js');
+var mergeDatabaseConfig = require('./mergeDatabaseConfig.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var knexFactory__default = /*#__PURE__*/_interopDefaultCompat(knexFactory);
+var limiterFactory__default = /*#__PURE__*/_interopDefaultCompat(limiterFactory);
+var yn__default = /*#__PURE__*/_interopDefaultCompat(yn);
+
+const ddlLimiter = limiterFactory__default.default(1);
+function createMysqlDatabaseClient(dbConfig, overrides) {
+  const knexConfig = buildMysqlDatabaseConfig(dbConfig, overrides);
+  const database = knexFactory__default.default(knexConfig);
+  return database;
+}
+function buildMysqlDatabaseConfig(dbConfig, overrides) {
+  return mergeDatabaseConfig.mergeDatabaseConfig(
+    dbConfig.get(),
+    {
+      connection: getMysqlConnectionConfig(dbConfig, !!overrides),
+      useNullAsDefault: true
+    },
+    overrides
+  );
+}
+function getMysqlConnectionConfig(dbConfig, parseConnectionString) {
+  const connection = dbConfig.get("connection");
+  const isConnectionString = typeof connection === "string" || connection instanceof String;
+  const autoParse = typeof parseConnectionString !== "boolean";
+  const shouldParseConnectionString = autoParse ? isConnectionString : parseConnectionString && isConnectionString;
+  return shouldParseConnectionString ? parseMysqlConnectionString(connection) : connection;
+}
+function parseMysqlConnectionString(connectionString) {
+  try {
+    const {
+      protocol,
+      username,
+      password,
+      port,
+      hostname,
+      pathname,
+      searchParams
+    } = new URL(connectionString);
+    if (protocol !== "mysql:") {
+      throw new Error(`Unknown protocol ${protocol}`);
+    } else if (!username || !password) {
+      throw new Error(`Missing username/password`);
+    } else if (!pathname.match(/^\/[^/]+$/)) {
+      throw new Error(`Expected single path segment`);
+    }
+    const result = {
+      user: username,
+      password,
+      host: hostname,
+      port: Number(port || 3306),
+      database: decodeURIComponent(pathname.substring(1))
+    };
+    const ssl = searchParams.get("ssl");
+    if (ssl) {
+      result.ssl = ssl;
+    }
+    const debug = searchParams.get("debug");
+    if (debug) {
+      result.debug = yn__default.default(debug);
+    }
+    return result;
+  } catch (e) {
+    throw new errors.InputError(
+      `Error while parsing MySQL connection string, ${e}`,
+      e
+    );
+  }
+}
+async function ensureMysqlDatabaseExists(dbConfig, ...databases) {
+  const admin = createMysqlDatabaseClient(dbConfig, {
+    connection: {
+      database: null
+    },
+    pool: {
+      min: 0,
+      acquireTimeoutMillis: 1e4
+    }
+  });
+  try {
+    const ensureDatabase = async (database) => {
+      await admin.raw(`CREATE DATABASE IF NOT EXISTS ??`, [database]);
+    };
+    await Promise.all(
+      databases.map(async (database) => {
+        let lastErr = void 0;
+        for (let i = 0; i < 3; i++) {
+          try {
+            return await ddlLimiter(() => ensureDatabase(database));
+          } catch (err) {
+            lastErr = err;
+          }
+          await new Promise((resolve) => setTimeout(resolve, 100));
+        }
+        throw lastErr;
+      })
+    );
+  } finally {
+    await admin.destroy();
+  }
+}
+function pluginPath(pluginId) {
+  return `plugin.${pluginId}`;
+}
+function normalizeConnection(connection) {
+  if (typeof connection === "undefined" || connection === null) {
+    return {};
+  }
+  return typeof connection === "string" || connection instanceof String ? parseMysqlConnectionString(connection) : connection;
+}
+class MysqlConnector {
+  constructor(config, prefix) {
+    this.config = config;
+    this.prefix = prefix;
+  }
+  async getClient(pluginId, _deps) {
+    const pluginConfig = new config.ConfigReader(
+      this.getConfigForPlugin(pluginId)
+    );
+    const databaseName = this.getDatabaseName(pluginId);
+    if (databaseName && this.getEnsureExistsConfig(pluginId)) {
+      try {
+        await ensureMysqlDatabaseExists(pluginConfig, databaseName);
+      } catch (error) {
+        throw new Error(
+          `Failed to connect to the database to make sure that '${databaseName}' exists, ${error}`
+        );
+      }
+    }
+    const pluginDivisionMode = this.getPluginDivisionModeConfig();
+    if (pluginDivisionMode !== "database") {
+      throw new Error(
+        `The MySQL driver does not support plugin division mode '${pluginDivisionMode}'`
+      );
+    }
+    const databaseClientOverrides = mergeDatabaseConfig.mergeDatabaseConfig(
+      {},
+      this.getDatabaseOverrides(pluginId)
+    );
+    const client = createMysqlDatabaseClient(
+      pluginConfig,
+      databaseClientOverrides
+    );
+    return client;
+  }
+  /**
+   * Provides the canonical database name for a given plugin.
+   *
+   * This method provides the effective database name which is determined using
+   * global and plugin specific database config. If no explicit database name,
+   * this method will provide a generated name which is the pluginId prefixed
+   * with 'backstage_plugin_'.
+   *
+   * @param pluginId - Lookup the database name for given plugin
+   * @returns String representing the plugin's database name
+   */
+  getDatabaseName(pluginId) {
+    const connection = this.getConnectionConfig(pluginId);
+    const databaseName = connection?.database;
+    return databaseName ?? `${this.prefix}${pluginId}`;
+  }
+  /**
+   * Provides the client type which should be used for a given plugin.
+   *
+   * The client type is determined by plugin specific config if present.
+   * Otherwise the base client is used as the fallback.
+   *
+   * @param pluginId - Plugin to get the client type for
+   * @returns Object with client type returned as `client` and boolean
+   *          representing whether or not the client was overridden as
+   *          `overridden`
+   */
+  getClientType(pluginId) {
+    const pluginClient = this.config.getOptionalString(
+      `${pluginPath(pluginId)}.client`
+    );
+    const baseClient = this.config.getString("client");
+    const client = pluginClient ?? baseClient;
+    return {
+      client,
+      overridden: client !== baseClient
+    };
+  }
+  getRoleConfig(pluginId) {
+    return this.config.getOptionalString(`${pluginPath(pluginId)}.role`) ?? this.config.getOptionalString("role");
+  }
+  /**
+   * Provides the knexConfig which should be used for a given plugin.
+   *
+   * @param pluginId - Plugin to get the knexConfig for
+   * @returns The merged knexConfig value or undefined if it isn't specified
+   */
+  getAdditionalKnexConfig(pluginId) {
+    const pluginConfig = this.config.getOptionalConfig(`${pluginPath(pluginId)}.knexConfig`)?.get();
+    const baseConfig = this.config.getOptionalConfig("knexConfig")?.get();
+    return lodash.merge(baseConfig, pluginConfig);
+  }
+  getEnsureExistsConfig(pluginId) {
+    const baseConfig = this.config.getOptionalBoolean("ensureExists") ?? true;
+    return this.config.getOptionalBoolean(`${pluginPath(pluginId)}.ensureExists`) ?? baseConfig;
+  }
+  getPluginDivisionModeConfig() {
+    return this.config.getOptionalString("pluginDivisionMode") ?? "database";
+  }
+  /**
+   * Provides a Knex connection plugin config by combining base and plugin
+   * config.
+   *
+   * This method provides a baseConfig for a plugin database connector. If the
+   * client type has not been overridden, the global connection config will be
+   * included with plugin specific config as the base. Values from the plugin
+   * connection take precedence over the base. Base database name is omitted
+   * unless `pluginDivisionMode` is set to `schema`.
+   */
+  getConnectionConfig(pluginId) {
+    const { overridden } = this.getClientType(pluginId);
+    let baseConnection = normalizeConnection(this.config.get("connection"));
+    if (this.getPluginDivisionModeConfig() !== "schema") {
+      baseConnection = lodash.omit(baseConnection, "database");
+    }
+    const connection = normalizeConnection(
+      this.config.getOptional(`${pluginPath(pluginId)}.connection`)
+    );
+    return {
+      // include base connection if client type has not been overridden
+      ...overridden ? {} : baseConnection,
+      ...connection
+    };
+  }
+  /**
+   * Provides a Knex database config for a given plugin.
+   *
+   * This method provides a Knex configuration object along with the plugin's
+   * client type.
+   *
+   * @param pluginId - The plugin that the database config should correspond with
+   */
+  getConfigForPlugin(pluginId) {
+    const { client } = this.getClientType(pluginId);
+    const role = this.getRoleConfig(pluginId);
+    return {
+      ...this.getAdditionalKnexConfig(pluginId),
+      client,
+      connection: this.getConnectionConfig(pluginId),
+      ...role && { role }
+    };
+  }
+  /**
+   * Provides a partial `Knex.Config`• database name override for a given plugin.
+   *
+   * @param pluginId - Target plugin to get database name override
+   * @returns Partial `Knex.Config` with database name override
+   */
+  getDatabaseOverrides(pluginId) {
+    const databaseName = this.getDatabaseName(pluginId);
+    return databaseName ? defaultNameOverride.default(databaseName) : {};
+  }
+}
+
+exports.MysqlConnector = MysqlConnector;
+exports.buildMysqlDatabaseConfig = buildMysqlDatabaseConfig;
+exports.createMysqlDatabaseClient = createMysqlDatabaseClient;
+exports.ensureMysqlDatabaseExists = ensureMysqlDatabaseExists;
+exports.getMysqlConnectionConfig = getMysqlConnectionConfig;
+exports.parseMysqlConnectionString = parseMysqlConnectionString;
+//# sourceMappingURL=mysql.cjs.js.map

package/dist/entrypoints/database/connectors/mysql.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mysql.cjs.js","sources":["../../../../src/entrypoints/database/connectors/mysql.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { LifecycleService, LoggerService } from '@backstage/backend-plugin-api';\nimport { Config, ConfigReader } from '@backstage/config';\nimport { InputError } from '@backstage/errors';\nimport { JsonObject } from '@backstage/types';\nimport knexFactory, { Knex } from 'knex';\nimport { merge, omit } from 'lodash';\nimport limiterFactory from 'p-limit';\nimport yn from 'yn';\nimport { Connector } from '../types';\nimport defaultNameOverride from './defaultNameOverride';\nimport { mergeDatabaseConfig } from './mergeDatabaseConfig';\n\n// Limits the number of concurrent DDL operations to 1\nconst ddlLimiter = limiterFactory(1);\n\n/**\n * Creates a knex mysql database connection\n *\n * @param dbConfig - The database config\n * @param overrides - Additional options to merge with the config\n */\nexport function createMysqlDatabaseClient(\n  dbConfig: Config,\n  overrides?: Knex.Config,\n) {\n  const knexConfig = buildMysqlDatabaseConfig(dbConfig, overrides);\n  const database = knexFactory(knexConfig);\n  return database;\n}\n\n/**\n * Builds a knex mysql database connection\n *\n * @param dbConfig - The database config\n * @param overrides - Additional options to merge with the config\n */\nexport function buildMysqlDatabaseConfig(\n  dbConfig: Config,\n  overrides?: Knex.Config,\n) {\n  return mergeDatabaseConfig(\n    dbConfig.get(),\n    {\n      connection: getMysqlConnectionConfig(dbConfig, !!overrides),\n      useNullAsDefault: true,\n    },\n    overrides,\n  );\n}\n\n/**\n * Gets the mysql connection config\n *\n * @param dbConfig - The database config\n * @param parseConnectionString - Flag to explicitly control connection string parsing\n */\nexport function getMysqlConnectionConfig(\n  dbConfig: Config,\n  parseConnectionString?: boolean,\n): Knex.MySqlConnectionConfig | string {\n  const connection = dbConfig.get('connection') as any;\n  const isConnectionString =\n    typeof connection === 'string' || connection instanceof String;\n  const autoParse = typeof parseConnectionString !== 'boolean';\n\n  const shouldParseConnectionString = autoParse\n    ? isConnectionString\n    : parseConnectionString && isConnectionString;\n\n  return shouldParseConnectionString\n    ? parseMysqlConnectionString(connection as string)\n    : connection;\n}\n\n/**\n * Parses a mysql connection string.\n *\n * e.g. mysql://examplename:somepassword@examplehost:3306/dbname\n * @param connectionString - The mysql connection string\n */\nexport function parseMysqlConnectionString(\n  connectionString: string,\n): Knex.MySqlConnectionConfig {\n  try {\n    const {\n      protocol,\n      username,\n      password,\n      port,\n      hostname,\n      pathname,\n      searchParams,\n    } = new URL(connectionString);\n\n    if (protocol !== 'mysql:') {\n      throw new Error(`Unknown protocol ${protocol}`);\n    } else if (!username || !password) {\n      throw new Error(`Missing username/password`);\n    } else if (!pathname.match(/^\\/[^/]+$/)) {\n      throw new Error(`Expected single path segment`);\n    }\n\n    const result: Knex.MySqlConnectionConfig = {\n      user: username,\n      password,\n      host: hostname,\n      port: Number(port || 3306),\n      database: decodeURIComponent(pathname.substring(1)),\n    };\n\n    const ssl = searchParams.get('ssl');\n    if (ssl) {\n      result.ssl = ssl;\n    }\n\n    const debug = searchParams.get('debug');\n    if (debug) {\n      result.debug = yn(debug);\n    }\n\n    return result;\n  } catch (e) {\n    throw new InputError(\n      `Error while parsing MySQL connection string, ${e}`,\n      e,\n    );\n  }\n}\n\n/**\n * Creates the missing mysql database if it does not exist\n *\n * @param dbConfig - The database config\n * @param databases - The names of the databases to create\n */\nexport async function ensureMysqlDatabaseExists(\n  dbConfig: Config,\n  ...databases: Array<string>\n) {\n  const admin = createMysqlDatabaseClient(dbConfig, {\n    connection: {\n      database: null as unknown as string,\n    },\n    pool: {\n      min: 0,\n      acquireTimeoutMillis: 10000,\n    },\n  });\n\n  try {\n    const ensureDatabase = async (database: string) => {\n      await admin.raw(`CREATE DATABASE IF NOT EXISTS ??`, [database]);\n    };\n    await Promise.all(\n      databases.map(async database => {\n        // For initial setup we use a smaller timeout but several retries. Given that this\n        // is a separate connection pool we should never really run into issues with connection\n        // acquisition timeouts, but we do anyway. This might be a bug in knex or some other dependency.\n        let lastErr: Error | undefined = undefined;\n        for (let i = 0; i < 3; i++) {\n          try {\n            return await ddlLimiter(() => ensureDatabase(database));\n          } catch (err) {\n            lastErr = err;\n          }\n          await new Promise(resolve => setTimeout(resolve, 100));\n        }\n        throw lastErr;\n      }),\n    );\n  } finally {\n    await admin.destroy();\n  }\n}\n\n/**\n * Drops the given mysql databases.\n *\n * @param dbConfig - The database config\n * @param databases - The names of the databases to create\n */\nexport async function dropMysqlDatabase(\n  dbConfig: Config,\n  ...databases: Array<string>\n) {\n  const admin = createMysqlDatabaseClient(dbConfig, {\n    connection: {\n      database: null as unknown as string,\n    },\n    pool: {\n      min: 0,\n      acquireTimeoutMillis: 10000,\n    },\n  });\n\n  try {\n    const dropDatabase = async (database: string) => {\n      await admin.raw(`DROP DATABASE ??`, [database]);\n    };\n    await Promise.all(\n      databases.map(async database => {\n        return await ddlLimiter(() => dropDatabase(database));\n      }),\n    );\n  } finally {\n    await admin.destroy();\n  }\n}\n\n/**\n * Provides a config lookup path for a plugin's config block.\n */\nfunction pluginPath(pluginId: string): string {\n  return `plugin.${pluginId}`;\n}\n\nfunction normalizeConnection(\n  connection: Knex.StaticConnectionConfig | JsonObject | string | undefined,\n): Partial<Knex.StaticConnectionConfig> {\n  if (typeof connection === 'undefined' || connection === null) {\n    return {};\n  }\n\n  return typeof connection === 'string' || connection instanceof String\n    ? parseMysqlConnectionString(connection as string)\n    : connection;\n}\n\nexport class MysqlConnector implements Connector {\n  constructor(\n    private readonly config: Config,\n    private readonly prefix: string,\n  ) {}\n\n  async getClient(\n    pluginId: string,\n    _deps: {\n      logger: LoggerService;\n      lifecycle: LifecycleService;\n    },\n  ): Promise<Knex> {\n    const pluginConfig = new ConfigReader(\n      this.getConfigForPlugin(pluginId) as JsonObject,\n    );\n\n    const databaseName = this.getDatabaseName(pluginId);\n    if (databaseName && this.getEnsureExistsConfig(pluginId)) {\n      try {\n        await ensureMysqlDatabaseExists(pluginConfig, databaseName);\n      } catch (error) {\n        throw new Error(\n          `Failed to connect to the database to make sure that '${databaseName}' exists, ${error}`,\n        );\n      }\n    }\n\n    const pluginDivisionMode = this.getPluginDivisionModeConfig();\n    if (pluginDivisionMode !== 'database') {\n      throw new Error(\n        `The MySQL driver does not support plugin division mode '${pluginDivisionMode}'`,\n      );\n    }\n\n    const databaseClientOverrides = mergeDatabaseConfig(\n      {},\n      this.getDatabaseOverrides(pluginId),\n    );\n\n    const client = createMysqlDatabaseClient(\n      pluginConfig,\n      databaseClientOverrides,\n    );\n\n    return client;\n  }\n\n  /**\n   * Provides the canonical database name for a given plugin.\n   *\n   * This method provides the effective database name which is determined using\n   * global and plugin specific database config. If no explicit database name,\n   * this method will provide a generated name which is the pluginId prefixed\n   * with 'backstage_plugin_'.\n   *\n   * @param pluginId - Lookup the database name for given plugin\n   * @returns String representing the plugin's database name\n   */\n  private getDatabaseName(pluginId: string): string | undefined {\n    const connection = this.getConnectionConfig(pluginId);\n    const databaseName = (connection as Knex.ConnectionConfig)?.database;\n    return databaseName ?? `${this.prefix}${pluginId}`;\n  }\n\n  /**\n   * Provides the client type which should be used for a given plugin.\n   *\n   * The client type is determined by plugin specific config if present.\n   * Otherwise the base client is used as the fallback.\n   *\n   * @param pluginId - Plugin to get the client type for\n   * @returns Object with client type returned as `client` and boolean\n   *          representing whether or not the client was overridden as\n   *          `overridden`\n   */\n  private getClientType(pluginId: string): {\n    client: string;\n    overridden: boolean;\n  } {\n    const pluginClient = this.config.getOptionalString(\n      `${pluginPath(pluginId)}.client`,\n    );\n\n    const baseClient = this.config.getString('client');\n    const client = pluginClient ?? baseClient;\n    return {\n      client,\n      overridden: client !== baseClient,\n    };\n  }\n\n  private getRoleConfig(pluginId: string): string | undefined {\n    return (\n      this.config.getOptionalString(`${pluginPath(pluginId)}.role`) ??\n      this.config.getOptionalString('role')\n    );\n  }\n\n  /**\n   * Provides the knexConfig which should be used for a given plugin.\n   *\n   * @param pluginId - Plugin to get the knexConfig for\n   * @returns The merged knexConfig value or undefined if it isn't specified\n   */\n  private getAdditionalKnexConfig(pluginId: string): JsonObject | undefined {\n    const pluginConfig = this.config\n      .getOptionalConfig(`${pluginPath(pluginId)}.knexConfig`)\n      ?.get<JsonObject>();\n\n    const baseConfig = this.config\n      .getOptionalConfig('knexConfig')\n      ?.get<JsonObject>();\n\n    return merge(baseConfig, pluginConfig);\n  }\n\n  private getEnsureExistsConfig(pluginId: string): boolean {\n    const baseConfig = this.config.getOptionalBoolean('ensureExists') ?? true;\n    return (\n      this.config.getOptionalBoolean(`${pluginPath(pluginId)}.ensureExists`) ??\n      baseConfig\n    );\n  }\n\n  private getPluginDivisionModeConfig(): string {\n    return this.config.getOptionalString('pluginDivisionMode') ?? 'database';\n  }\n\n  /**\n   * Provides a Knex connection plugin config by combining base and plugin\n   * config.\n   *\n   * This method provides a baseConfig for a plugin database connector. If the\n   * client type has not been overridden, the global connection config will be\n   * included with plugin specific config as the base. Values from the plugin\n   * connection take precedence over the base. Base database name is omitted\n   * unless `pluginDivisionMode` is set to `schema`.\n   */\n  private getConnectionConfig(pluginId: string): Knex.StaticConnectionConfig {\n    const { overridden } = this.getClientType(pluginId);\n\n    let baseConnection = normalizeConnection(this.config.get('connection'));\n\n    // Databases cannot be shared unless the `pluginDivisionMode` is set to `schema`. The\n    // `database` property from the base connection is omitted unless `pluginDivisionMode`\n    // is set to `schema`.\n    if (this.getPluginDivisionModeConfig() !== 'schema') {\n      baseConnection = omit(baseConnection, 'database');\n    }\n\n    // get and normalize optional plugin specific database connection\n    const connection = normalizeConnection(\n      this.config.getOptional(`${pluginPath(pluginId)}.connection`),\n    );\n\n    return {\n      // include base connection if client type has not been overridden\n      ...(overridden ? {} : baseConnection),\n      ...connection,\n    } as Knex.StaticConnectionConfig;\n  }\n\n  /**\n   * Provides a Knex database config for a given plugin.\n   *\n   * This method provides a Knex configuration object along with the plugin's\n   * client type.\n   *\n   * @param pluginId - The plugin that the database config should correspond with\n   */\n  private getConfigForPlugin(pluginId: string): Knex.Config {\n    const { client } = this.getClientType(pluginId);\n    const role = this.getRoleConfig(pluginId);\n\n    return {\n      ...this.getAdditionalKnexConfig(pluginId),\n      client,\n      connection: this.getConnectionConfig(pluginId),\n      ...(role && { role }),\n    };\n  }\n\n  /**\n   * Provides a partial `Knex.Config`• database name override for a given plugin.\n   *\n   * @param pluginId - Target plugin to get database name override\n   * @returns Partial `Knex.Config` with database name override\n   */\n  private getDatabaseOverrides(pluginId: string): Knex.Config {\n    const databaseName = this.getDatabaseName(pluginId);\n    return databaseName ? defaultNameOverride(databaseName) : {};\n  }\n}\n"],"names":["limiterFactory","knexFactory","mergeDatabaseConfig","yn","InputError","ConfigReader","merge","omit","defaultNameOverride"],"mappings":";;;;;;;;;;;;;;;;;AA6BA,MAAM,UAAA,GAAaA,gCAAe,CAAC,CAAA,CAAA;AAQnB,SAAA,yBAAA,CACd,UACA,SACA,EAAA;AACA,EAAM,MAAA,UAAA,GAAa,wBAAyB,CAAA,QAAA,EAAU,SAAS,CAAA,CAAA;AAC/D,EAAM,MAAA,QAAA,GAAWC,6BAAY,UAAU,CAAA,CAAA;AACvC,EAAO,OAAA,QAAA,CAAA;AACT,CAAA;AAQgB,SAAA,wBAAA,CACd,UACA,SACA,EAAA;AACA,EAAO,OAAAC,uCAAA;AAAA,IACL,SAAS,GAAI,EAAA;AAAA,IACb;AAAA,MACE,UAAY,EAAA,wBAAA,CAAyB,QAAU,EAAA,CAAC,CAAC,SAAS,CAAA;AAAA,MAC1D,gBAAkB,EAAA,IAAA;AAAA,KACpB;AAAA,IACA,SAAA;AAAA,GACF,CAAA;AACF,CAAA;AAQgB,SAAA,wBAAA,CACd,UACA,qBACqC,EAAA;AACrC,EAAM,MAAA,UAAA,GAAa,QAAS,CAAA,GAAA,CAAI,YAAY,CAAA,CAAA;AAC5C,EAAA,MAAM,kBACJ,GAAA,OAAO,UAAe,KAAA,QAAA,IAAY,UAAsB,YAAA,MAAA,CAAA;AAC1D,EAAM,MAAA,SAAA,GAAY,OAAO,qBAA0B,KAAA,SAAA,CAAA;AAEnD,EAAM,MAAA,2BAAA,GAA8B,SAChC,GAAA,kBAAA,GACA,qBAAyB,IAAA,kBAAA,CAAA;AAE7B,EAAO,OAAA,2BAAA,GACH,0BAA2B,CAAA,UAAoB,CAC/C,GAAA,UAAA,CAAA;AACN,CAAA;AAQO,SAAS,2BACd,gBAC4B,EAAA;AAC5B,EAAI,IAAA;AACF,IAAM,MAAA;AAAA,MACJ,QAAA;AAAA,MACA,QAAA;AAAA,MACA,QAAA;AAAA,MACA,IAAA;AAAA,MACA,QAAA;AAAA,MACA,QAAA;AAAA,MACA,YAAA;AAAA,KACF,GAAI,IAAI,GAAA,CAAI,gBAAgB,CAAA,CAAA;AAE5B,IAAA,IAAI,aAAa,QAAU,EAAA;AACzB,MAAA,MAAM,IAAI,KAAA,CAAM,CAAoB,iBAAA,EAAA,QAAQ,CAAE,CAAA,CAAA,CAAA;AAAA,KACrC,MAAA,IAAA,CAAC,QAAY,IAAA,CAAC,QAAU,EAAA;AACjC,MAAM,MAAA,IAAI,MAAM,CAA2B,yBAAA,CAAA,CAAA,CAAA;AAAA,KAClC,MAAA,IAAA,CAAC,QAAS,CAAA,KAAA,CAAM,WAAW,CAAG,EAAA;AACvC,MAAM,MAAA,IAAI,MAAM,CAA8B,4BAAA,CAAA,CAAA,CAAA;AAAA,KAChD;AAEA,IAAA,MAAM,MAAqC,GAAA;AAAA,MACzC,IAAM,EAAA,QAAA;AAAA,MACN,QAAA;AAAA,MACA,IAAM,EAAA,QAAA;AAAA,MACN,IAAA,EAAM,MAAO,CAAA,IAAA,IAAQ,IAAI,CAAA;AAAA,MACzB,QAAU,EAAA,kBAAA,CAAmB,QAAS,CAAA,SAAA,CAAU,CAAC,CAAC,CAAA;AAAA,KACpD,CAAA;AAEA,IAAM,MAAA,GAAA,GAAM,YAAa,CAAA,GAAA,CAAI,KAAK,CAAA,CAAA;AAClC,IAAA,IAAI,GAAK,EAAA;AACP,MAAA,MAAA,CAAO,GAAM,GAAA,GAAA,CAAA;AAAA,KACf;AAEA,IAAM,MAAA,KAAA,GAAQ,YAAa,CAAA,GAAA,CAAI,OAAO,CAAA,CAAA;AACtC,IAAA,IAAI,KAAO,EAAA;AACT,MAAO,MAAA,CAAA,KAAA,GAAQC,oBAAG,KAAK,CAAA,CAAA;AAAA,KACzB;AAEA,IAAO,OAAA,MAAA,CAAA;AAAA,WACA,CAAG,EAAA;AACV,IAAA,MAAM,IAAIC,iBAAA;AAAA,MACR,gDAAgD,CAAC,CAAA,CAAA;AAAA,MACjD,CAAA;AAAA,KACF,CAAA;AAAA,GACF;AACF,CAAA;AAQsB,eAAA,yBAAA,CACpB,aACG,SACH,EAAA;AACA,EAAM,MAAA,KAAA,GAAQ,0BAA0B,QAAU,EAAA;AAAA,IAChD,UAAY,EAAA;AAAA,MACV,QAAU,EAAA,IAAA;AAAA,KACZ;AAAA,IACA,IAAM,EAAA;AAAA,MACJ,GAAK,EAAA,CAAA;AAAA,MACL,oBAAsB,EAAA,GAAA;AAAA,KACxB;AAAA,GACD,CAAA,CAAA;AAED,EAAI,IAAA;AACF,IAAM,MAAA,cAAA,GAAiB,OAAO,QAAqB,KAAA;AACjD,MAAA,MAAM,KAAM,CAAA,GAAA,CAAI,CAAoC,gCAAA,CAAA,EAAA,CAAC,QAAQ,CAAC,CAAA,CAAA;AAAA,KAChE,CAAA;AACA,IAAA,MAAM,OAAQ,CAAA,GAAA;AAAA,MACZ,SAAA,CAAU,GAAI,CAAA,OAAM,QAAY,KAAA;AAI9B,QAAA,IAAI,OAA6B,GAAA,KAAA,CAAA,CAAA;AACjC,QAAA,KAAA,IAAS,CAAI,GAAA,CAAA,EAAG,CAAI,GAAA,CAAA,EAAG,CAAK,EAAA,EAAA;AAC1B,UAAI,IAAA;AACF,YAAA,OAAO,MAAM,UAAA,CAAW,MAAM,cAAA,CAAe,QAAQ,CAAC,CAAA,CAAA;AAAA,mBAC/C,GAAK,EAAA;AACZ,YAAU,OAAA,GAAA,GAAA,CAAA;AAAA,WACZ;AACA,UAAA,MAAM,IAAI,OAAQ,CAAA,CAAA,OAAA,KAAW,UAAW,CAAA,OAAA,EAAS,GAAG,CAAC,CAAA,CAAA;AAAA,SACvD;AACA,QAAM,MAAA,OAAA,CAAA;AAAA,OACP,CAAA;AAAA,KACH,CAAA;AAAA,GACA,SAAA;AACA,IAAA,MAAM,MAAM,OAAQ,EAAA,CAAA;AAAA,GACtB;AACF,CAAA;AAuCA,SAAS,WAAW,QAA0B,EAAA;AAC5C,EAAA,OAAO,UAAU,QAAQ,CAAA,CAAA,CAAA;AAC3B,CAAA;AAEA,SAAS,oBACP,UACsC,EAAA;AACtC,EAAA,IAAI,OAAO,UAAA,KAAe,WAAe,IAAA,UAAA,KAAe,IAAM,EAAA;AAC5D,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AAEA,EAAA,OAAO,OAAO,UAAe,KAAA,QAAA,IAAY,sBAAsB,MAC3D,GAAA,0BAAA,CAA2B,UAAoB,CAC/C,GAAA,UAAA,CAAA;AACN,CAAA;AAEO,MAAM,cAAoC,CAAA;AAAA,EAC/C,WAAA,CACmB,QACA,MACjB,EAAA;AAFiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AAAA,GAChB;AAAA,EAEH,MAAM,SACJ,CAAA,QAAA,EACA,KAIe,EAAA;AACf,IAAA,MAAM,eAAe,IAAIC,mBAAA;AAAA,MACvB,IAAA,CAAK,mBAAmB,QAAQ,CAAA;AAAA,KAClC,CAAA;AAEA,IAAM,MAAA,YAAA,GAAe,IAAK,CAAA,eAAA,CAAgB,QAAQ,CAAA,CAAA;AAClD,IAAA,IAAI,YAAgB,IAAA,IAAA,CAAK,qBAAsB,CAAA,QAAQ,CAAG,EAAA;AACxD,MAAI,IAAA;AACF,QAAM,MAAA,yBAAA,CAA0B,cAAc,YAAY,CAAA,CAAA;AAAA,eACnD,KAAO,EAAA;AACd,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,qDAAA,EAAwD,YAAY,CAAA,UAAA,EAAa,KAAK,CAAA,CAAA;AAAA,SACxF,CAAA;AAAA,OACF;AAAA,KACF;AAEA,IAAM,MAAA,kBAAA,GAAqB,KAAK,2BAA4B,EAAA,CAAA;AAC5D,IAAA,IAAI,uBAAuB,UAAY,EAAA;AACrC,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,2DAA2D,kBAAkB,CAAA,CAAA,CAAA;AAAA,OAC/E,CAAA;AAAA,KACF;AAEA,IAAA,MAAM,uBAA0B,GAAAH,uCAAA;AAAA,MAC9B,EAAC;AAAA,MACD,IAAA,CAAK,qBAAqB,QAAQ,CAAA;AAAA,KACpC,CAAA;AAEA,IAAA,MAAM,MAAS,GAAA,yBAAA;AAAA,MACb,YAAA;AAAA,MACA,uBAAA;AAAA,KACF,CAAA;AAEA,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaQ,gBAAgB,QAAsC,EAAA;AAC5D,IAAM,MAAA,UAAA,GAAa,IAAK,CAAA,mBAAA,CAAoB,QAAQ,CAAA,CAAA;AACpD,IAAA,MAAM,eAAgB,UAAsC,EAAA,QAAA,CAAA;AAC5D,IAAA,OAAO,YAAgB,IAAA,CAAA,EAAG,IAAK,CAAA,MAAM,GAAG,QAAQ,CAAA,CAAA,CAAA;AAAA,GAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaQ,cAAc,QAGpB,EAAA;AACA,IAAM,MAAA,YAAA,GAAe,KAAK,MAAO,CAAA,iBAAA;AAAA,MAC/B,CAAA,EAAG,UAAW,CAAA,QAAQ,CAAC,CAAA,OAAA,CAAA;AAAA,KACzB,CAAA;AAEA,IAAA,MAAM,UAAa,GAAA,IAAA,CAAK,MAAO,CAAA,SAAA,CAAU,QAAQ,CAAA,CAAA;AACjD,IAAA,MAAM,SAAS,YAAgB,IAAA,UAAA,CAAA;AAC/B,IAAO,OAAA;AAAA,MACL,MAAA;AAAA,MACA,YAAY,MAAW,KAAA,UAAA;AAAA,KACzB,CAAA;AAAA,GACF;AAAA,EAEQ,cAAc,QAAsC,EAAA;AAC1D,IAAA,OACE,IAAK,CAAA,MAAA,CAAO,iBAAkB,CAAA,CAAA,EAAG,UAAW,CAAA,QAAQ,CAAC,CAAA,KAAA,CAAO,CAC5D,IAAA,IAAA,CAAK,MAAO,CAAA,iBAAA,CAAkB,MAAM,CAAA,CAAA;AAAA,GAExC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQQ,wBAAwB,QAA0C,EAAA;AACxE,IAAM,MAAA,YAAA,GAAe,IAAK,CAAA,MAAA,CACvB,iBAAkB,CAAA,CAAA,EAAG,WAAW,QAAQ,CAAC,CAAa,WAAA,CAAA,CAAA,EACrD,GAAgB,EAAA,CAAA;AAEpB,IAAA,MAAM,aAAa,IAAK,CAAA,MAAA,CACrB,iBAAkB,CAAA,YAAY,GAC7B,GAAgB,EAAA,CAAA;AAEpB,IAAO,OAAAI,YAAA,CAAM,YAAY,YAAY,CAAA,CAAA;AAAA,GACvC;AAAA,EAEQ,sBAAsB,QAA2B,EAAA;AACvD,IAAA,MAAM,UAAa,GAAA,IAAA,CAAK,MAAO,CAAA,kBAAA,CAAmB,cAAc,CAAK,IAAA,IAAA,CAAA;AACrE,IACE,OAAA,IAAA,CAAK,OAAO,kBAAmB,CAAA,CAAA,EAAG,WAAW,QAAQ,CAAC,eAAe,CACrE,IAAA,UAAA,CAAA;AAAA,GAEJ;AAAA,EAEQ,2BAAsC,GAAA;AAC5C,IAAA,OAAO,IAAK,CAAA,MAAA,CAAO,iBAAkB,CAAA,oBAAoB,CAAK,IAAA,UAAA,CAAA;AAAA,GAChE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYQ,oBAAoB,QAA+C,EAAA;AACzE,IAAA,MAAM,EAAE,UAAA,EAAe,GAAA,IAAA,CAAK,cAAc,QAAQ,CAAA,CAAA;AAElD,IAAA,IAAI,iBAAiB,mBAAoB,CAAA,IAAA,CAAK,MAAO,CAAA,GAAA,CAAI,YAAY,CAAC,CAAA,CAAA;AAKtE,IAAI,IAAA,IAAA,CAAK,2BAA4B,EAAA,KAAM,QAAU,EAAA;AACnD,MAAiB,cAAA,GAAAC,WAAA,CAAK,gBAAgB,UAAU,CAAA,CAAA;AAAA,KAClD;AAGA,IAAA,MAAM,UAAa,GAAA,mBAAA;AAAA,MACjB,KAAK,MAAO,CAAA,WAAA,CAAY,GAAG,UAAW,CAAA,QAAQ,CAAC,CAAa,WAAA,CAAA,CAAA;AAAA,KAC9D,CAAA;AAEA,IAAO,OAAA;AAAA;AAAA,MAEL,GAAI,UAAa,GAAA,EAAK,GAAA,cAAA;AAAA,MACtB,GAAG,UAAA;AAAA,KACL,CAAA;AAAA,GACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUQ,mBAAmB,QAA+B,EAAA;AACxD,IAAA,MAAM,EAAE,MAAA,EAAW,GAAA,IAAA,CAAK,cAAc,QAAQ,CAAA,CAAA;AAC9C,IAAM,MAAA,IAAA,GAAO,IAAK,CAAA,aAAA,CAAc,QAAQ,CAAA,CAAA;AAExC,IAAO,OAAA;AAAA,MACL,GAAG,IAAK,CAAA,uBAAA,CAAwB,QAAQ,CAAA;AAAA,MACxC,MAAA;AAAA,MACA,UAAA,EAAY,IAAK,CAAA,mBAAA,CAAoB,QAAQ,CAAA;AAAA,MAC7C,GAAI,IAAQ,IAAA,EAAE,IAAK,EAAA;AAAA,KACrB,CAAA;AAAA,GACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQQ,qBAAqB,QAA+B,EAAA;AAC1D,IAAM,MAAA,YAAA,GAAe,IAAK,CAAA,eAAA,CAAgB,QAAQ,CAAA,CAAA;AAClD,IAAA,OAAO,YAAe,GAAAC,2BAAA,CAAoB,YAAY,CAAA,GAAI,EAAC,CAAA;AAAA,GAC7D;AACF;;;;;;;;;"}

package/dist/entrypoints/database/connectors/postgres.cjs.js

@@ -0,0 +1,304 @@
+'use strict';
+
+var config = require('@backstage/config');
+var errors = require('@backstage/errors');
+var knexFactory = require('knex');
+var lodash = require('lodash');
+var limiterFactory = require('p-limit');
+var defaultNameOverride = require('./defaultNameOverride.cjs.js');
+var defaultSchemaOverride = require('./defaultSchemaOverride.cjs.js');
+var mergeDatabaseConfig = require('./mergeDatabaseConfig.cjs.js');
+var format = require('pg-format');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var knexFactory__default = /*#__PURE__*/_interopDefaultCompat(knexFactory);
+var limiterFactory__default = /*#__PURE__*/_interopDefaultCompat(limiterFactory);
+var format__default = /*#__PURE__*/_interopDefaultCompat(format);
+
+const ddlLimiter = limiterFactory__default.default(1);
+function createPgDatabaseClient(dbConfig, overrides) {
+  const knexConfig = buildPgDatabaseConfig(dbConfig, overrides);
+  const database = knexFactory__default.default(knexConfig);
+  const role = dbConfig.getOptionalString("role");
+  if (role) {
+    database.client.pool.on(
+      "createSuccess",
+      async (_event, pgClient) => {
+        const query = format__default.default("SET ROLE %I", role);
+        await pgClient.query(query);
+      }
+    );
+  }
+  return database;
+}
+function buildPgDatabaseConfig(dbConfig, overrides) {
+  return mergeDatabaseConfig.mergeDatabaseConfig(
+    dbConfig.get(),
+    {
+      connection: getPgConnectionConfig(dbConfig, !!overrides),
+      useNullAsDefault: true
+    },
+    overrides
+  );
+}
+function getPgConnectionConfig(dbConfig, parseConnectionString) {
+  const connection = dbConfig.get("connection");
+  const isConnectionString = typeof connection === "string" || connection instanceof String;
+  const autoParse = typeof parseConnectionString !== "boolean";
+  const shouldParseConnectionString = autoParse ? isConnectionString : parseConnectionString && isConnectionString;
+  return shouldParseConnectionString ? parsePgConnectionString(connection) : connection;
+}
+function parsePgConnectionString(connectionString) {
+  const parse = requirePgConnectionString();
+  return parse(connectionString);
+}
+function requirePgConnectionString() {
+  try {
+    return require("pg-connection-string").parse;
+  } catch (e) {
+    throw new errors.ForwardedError("Postgres: Install 'pg-connection-string'", e);
+  }
+}
+async function ensurePgDatabaseExists(dbConfig, ...databases) {
+  const admin = createPgDatabaseClient(dbConfig, {
+    connection: {
+      database: "postgres"
+    },
+    pool: {
+      min: 0,
+      acquireTimeoutMillis: 1e4
+    }
+  });
+  try {
+    const ensureDatabase = async (database) => {
+      const result = await admin.from("pg_database").where("datname", database).count();
+      if (parseInt(result[0].count, 10) > 0) {
+        return;
+      }
+      await admin.raw(`CREATE DATABASE ??`, [database]);
+    };
+    await Promise.all(
+      databases.map(async (database) => {
+        let lastErr = void 0;
+        for (let i = 0; i < 3; i++) {
+          try {
+            return await ddlLimiter(() => ensureDatabase(database));
+          } catch (err) {
+            lastErr = err;
+          }
+          await new Promise((resolve) => setTimeout(resolve, 100));
+        }
+        throw lastErr;
+      })
+    );
+  } finally {
+    await admin.destroy();
+  }
+}
+async function ensurePgSchemaExists(dbConfig, ...schemas) {
+  const admin = createPgDatabaseClient(dbConfig);
+  const role = dbConfig.getOptionalString("role");
+  try {
+    const ensureSchema = async (database) => {
+      if (role) {
+        await admin.raw(`CREATE SCHEMA IF NOT EXISTS ?? AUTHORIZATION ??`, [
+          database,
+          role
+        ]);
+      } else {
+        await admin.raw(`CREATE SCHEMA IF NOT EXISTS ??`, [database]);
+      }
+    };
+    await Promise.all(
+      schemas.map((database) => ddlLimiter(() => ensureSchema(database)))
+    );
+  } finally {
+    await admin.destroy();
+  }
+}
+function pluginPath(pluginId) {
+  return `plugin.${pluginId}`;
+}
+function normalizeConnection(connection) {
+  if (typeof connection === "undefined" || connection === null) {
+    return {};
+  }
+  return typeof connection === "string" || connection instanceof String ? parsePgConnectionString(connection) : connection;
+}
+class PgConnector {
+  constructor(config, prefix) {
+    this.config = config;
+    this.prefix = prefix;
+  }
+  async getClient(pluginId, _deps) {
+    const pluginConfig = new config.ConfigReader(
+      this.getConfigForPlugin(pluginId)
+    );
+    const databaseName = this.getDatabaseName(pluginId);
+    if (databaseName && this.getEnsureExistsConfig(pluginId)) {
+      try {
+        await ensurePgDatabaseExists(pluginConfig, databaseName);
+      } catch (error) {
+        throw new Error(
+          `Failed to connect to the database to make sure that '${databaseName}' exists, ${error}`
+        );
+      }
+    }
+    let schemaOverrides;
+    if (this.getPluginDivisionModeConfig() === "schema") {
+      schemaOverrides = defaultSchemaOverride.default(pluginId);
+      if (this.getEnsureSchemaExistsConfig(pluginId) || this.getEnsureExistsConfig(pluginId)) {
+        try {
+          await ensurePgSchemaExists(pluginConfig, pluginId);
+        } catch (error) {
+          throw new Error(
+            `Failed to connect to the database to make sure that schema for plugin '${pluginId}' exists, ${error}`
+          );
+        }
+      }
+    }
+    const databaseClientOverrides = mergeDatabaseConfig.mergeDatabaseConfig(
+      {},
+      this.getDatabaseOverrides(pluginId),
+      schemaOverrides
+    );
+    const client = createPgDatabaseClient(
+      pluginConfig,
+      databaseClientOverrides
+    );
+    return client;
+  }
+  /**
+   * Provides the canonical database name for a given plugin.
+   *
+   * This method provides the effective database name which is determined using global
+   * and plugin specific database config. If no explicit database name is configured
+   * and `pluginDivisionMode` is not `schema`, this method will provide a generated name
+   * which is the pluginId prefixed with 'backstage_plugin_'. If `pluginDivisionMode` is
+   * `schema`, it will fallback to using the default database for the knex instance.
+   *
+   * @param pluginId - Lookup the database name for given plugin
+   * @returns String representing the plugin's database name
+   */
+  getDatabaseName(pluginId) {
+    const connection = this.getConnectionConfig(pluginId);
+    const databaseName = connection?.database;
+    if (this.getPluginDivisionModeConfig() === "schema") {
+      return databaseName;
+    }
+    return databaseName ?? `${this.prefix}${pluginId}`;
+  }
+  /**
+   * Provides the client type which should be used for a given plugin.
+   *
+   * The client type is determined by plugin specific config if present.
+   * Otherwise the base client is used as the fallback.
+   *
+   * @param pluginId - Plugin to get the client type for
+   * @returns Object with client type returned as `client` and boolean
+   *          representing whether or not the client was overridden as
+   *          `overridden`
+   */
+  getClientType(pluginId) {
+    const pluginClient = this.config.getOptionalString(
+      `${pluginPath(pluginId)}.client`
+    );
+    const baseClient = this.config.getString("client");
+    const client = pluginClient ?? baseClient;
+    return {
+      client,
+      overridden: client !== baseClient
+    };
+  }
+  getRoleConfig(pluginId) {
+    return this.config.getOptionalString(`${pluginPath(pluginId)}.role`) ?? this.config.getOptionalString("role");
+  }
+  /**
+   * Provides the knexConfig which should be used for a given plugin.
+   *
+   * @param pluginId - Plugin to get the knexConfig for
+   * @returns The merged knexConfig value or undefined if it isn't specified
+   */
+  getAdditionalKnexConfig(pluginId) {
+    const pluginConfig = this.config.getOptionalConfig(`${pluginPath(pluginId)}.knexConfig`)?.get();
+    const baseConfig = this.config.getOptionalConfig("knexConfig")?.get();
+    return lodash.merge(baseConfig, pluginConfig);
+  }
+  getEnsureExistsConfig(pluginId) {
+    const baseConfig = this.config.getOptionalBoolean("ensureExists") ?? true;
+    return this.config.getOptionalBoolean(`${pluginPath(pluginId)}.ensureExists`) ?? baseConfig;
+  }
+  getEnsureSchemaExistsConfig(pluginId) {
+    const baseConfig = this.config.getOptionalBoolean("ensureSchemaExists") ?? false;
+    return this.config.getOptionalBoolean(
+      `${pluginPath(pluginId)}.getEnsureSchemaExistsConfig`
+    ) ?? baseConfig;
+  }
+  getPluginDivisionModeConfig() {
+    return this.config.getOptionalString("pluginDivisionMode") ?? "database";
+  }
+  /**
+   * Provides a Knex connection plugin config by combining base and plugin
+   * config.
+   *
+   * This method provides a baseConfig for a plugin database connector. If the
+   * client type has not been overridden, the global connection config will be
+   * included with plugin specific config as the base. Values from the plugin
+   * connection take precedence over the base. Base database name is omitted
+   * unless `pluginDivisionMode` is set to `schema`.
+   */
+  getConnectionConfig(pluginId) {
+    const { overridden } = this.getClientType(pluginId);
+    let baseConnection = normalizeConnection(this.config.get("connection"));
+    if (this.getPluginDivisionModeConfig() !== "schema") {
+      baseConnection = lodash.omit(baseConnection, "database");
+    }
+    const connection = normalizeConnection(
+      this.config.getOptional(`${pluginPath(pluginId)}.connection`)
+    );
+    baseConnection.application_name ||= `backstage_plugin_${pluginId}`;
+    return {
+      // include base connection if client type has not been overridden
+      ...overridden ? {} : baseConnection,
+      ...connection
+    };
+  }
+  /**
+   * Provides a Knex database config for a given plugin.
+   *
+   * This method provides a Knex configuration object along with the plugin's
+   * client type.
+   *
+   * @param pluginId - The plugin that the database config should correspond with
+   */
+  getConfigForPlugin(pluginId) {
+    const { client } = this.getClientType(pluginId);
+    const role = this.getRoleConfig(pluginId);
+    return {
+      ...this.getAdditionalKnexConfig(pluginId),
+      client,
+      connection: this.getConnectionConfig(pluginId),
+      ...role && { role }
+    };
+  }
+  /**
+   * Provides a partial `Knex.Config`• database name override for a given plugin.
+   *
+   * @param pluginId - Target plugin to get database name override
+   * @returns Partial `Knex.Config` with database name override
+   */
+  getDatabaseOverrides(pluginId) {
+    const databaseName = this.getDatabaseName(pluginId);
+    return databaseName ? defaultNameOverride.default(databaseName) : {};
+  }
+}
+
+exports.PgConnector = PgConnector;
+exports.buildPgDatabaseConfig = buildPgDatabaseConfig;
+exports.createPgDatabaseClient = createPgDatabaseClient;
+exports.ensurePgDatabaseExists = ensurePgDatabaseExists;
+exports.ensurePgSchemaExists = ensurePgSchemaExists;
+exports.getPgConnectionConfig = getPgConnectionConfig;
+exports.parsePgConnectionString = parsePgConnectionString;
+//# sourceMappingURL=postgres.cjs.js.map