Skip to main content

DatabaseService

Home > @backstage/backend-plugin-api > DatabaseService

The DatabaseService manages access to databases that Plugins get.

Signature:

export interface DatabaseService 

Properties

PropertyModifiersTypeDescription
migrations?{ skip?: boolean; }(Optional) This property is used to control the behavior of database migrations.

Methods

MethodDescription
getClient()

getClient provides backend plugins database connections for itself.

The purpose of this method is to allow plugins to get isolated data stores so that plugins are discouraged from database integration.