Skip to main content

DatabaseManager

Home > @backstage/backend-common > DatabaseManager

Manages database connections for Backstage backend plugins.

Signature:

class DatabaseManager implements LegacyRootDatabaseService 

Implements: LegacyRootDatabaseService

Remarks

The database manager allows the user to set connection and client settings on a per pluginId basis by defining a database config block under plugin.<pluginId> in addition to top level defaults. Optionally, a user may set prefix which is used to prefix generated database names if config is not provided.

Methods

MethodModifiersDescription
forPlugin(pluginId, deps)Generates a PluginDatabaseManager for consumption by plugins.
fromConfig(config, options)staticCreates a DatabaseManager from backend.database config.