Interface DatabaseService

Manages access to databases that plugins get.

See the service documentation for more details.

interface DatabaseService {
migrations?: { skip?: boolean };
getClient(): Promise<Knex<any, any[]>>;
}

Index

Properties

Methods

Properties

`Optional`migrations

migrations?: { skip?: boolean }

This property is used to control the behavior of database migrations.

Type Declaration

Optionalskip?: boolean
skip database migrations. Useful if connecting to a read-only database.
Default Value
```
false
```

Methods

getClient

getClient(): Promise<Knex<any, any[]>>
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.

Returns Promise<Knex<any, any[]>>
- Defined in packages/backend-plugin-api/src/services/definitions/DatabaseService.ts:33