@proto-kit/processorDocs


Documentation / @proto-kit/processor / Database

Class: Database<PrismaClient>

Used by various module sub-types that may need to be configured

Extends

Type Parameters

PrismaClient extends BasePrismaClient

Implements

  • PrismaDatabaseConnection<PrismaClient>

Constructors

new Database()

new Database<PrismaClient>(prismaClient): Database<PrismaClient>

Parameters

prismaClient: PrismaClient

Returns

Database<PrismaClient>

Overrides

ProcessorModule.constructor

Defined in

packages/processor/src/storage/Database.ts:16

Properties

currentConfig

protected currentConfig: undefined | NoConfig

Store the config separately, so that we can apply additional checks when retrieving it via the getter

Inherited from

ProcessorModule.currentConfig

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:17


prismaClient

prismaClient: PrismaClient

Implementation of

PrismaDatabaseConnection.prismaClient

Defined in

packages/processor/src/storage/Database.ts:16

Accessors

config

Get Signature

get config(): Config

Returns

Config

Set Signature

set config(config): void

Parameters

config: Config

Returns

void

Inherited from

ProcessorModule.config

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:18

Methods

create()

create(childContainerProvider): void

Parameters

childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

ProcessorModule.create

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:20


pruneDatabase()

pruneDatabase(): Promise<void>

Returns

Promise<void>

Defined in

packages/processor/src/storage/Database.ts:38


start()

start(): Promise<void>

Returns

Promise<void>

Overrides

ProcessorModule.start

Defined in

packages/processor/src/storage/Database.ts:51


dependencies()

static dependencies(): object

Returns

object

BlockStorage

BlockStorage: object

BlockStorage.useClass

BlockStorage.useClass: typeof BlockStorage = BlockStorage

Defined in

packages/processor/src/storage/Database.ts:30


from()

static from<PrismaClient>(prismaClient): TypedClass<Database<PrismaClient>>

Type Parameters

PrismaClient extends BasePrismaClient

Parameters

prismaClient: PrismaClient

Returns

TypedClass<Database<PrismaClient>>

Defined in

packages/processor/src/storage/Database.ts:20