Classpluginsv0.6.1

KyselyPg

Postgres plugin using Kysely.

Handles setting up the connection pool, applying migrations, and registering decorated services so they can be resolved from the core.

class KyselyPg<Database extends object> extends Plugin

class KyselyPg<Database extends object> extends Plugin

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the KyselyPgKyselyPg class

KyselyPg(core: Core, options: KpgOptions)

KyselyPg(core: Core, options: KpgOptions)

Showing members with Protected visibility and higher.

Methods

init()
listMigrations()
listPendingMigrations()
migrate()
migrateDown()
migrateUp()
stop()

Database

Database extends object

Database extends object

connection

Exposed Kysely instance once initinit completes.

public connection: Kysely<Database>

public connection: Kysely<Database>

core

public readonly core: Core

public readonly core: Core

logger

public readonly logger: Logger

public readonly logger: Logger

accessor

services

Map of all services registered with the plugin, keyed by their decorator name.

public get services(): KpgServices

public get services(): KpgServices

init()

Connects to Postgres, runs any startup migrations, and loads decorated services.

Safe to call multiple times; subsequent calls exit early.

public async init(): Promise<void>

public async init(): Promise<void>

listMigrations()

Lists every migration registered with the manager along with its execution state.

public async listMigrations(): Promise<readonly MigrationInfo[]>

public async listMigrations(): Promise<readonly MigrationInfo[]>

listPendingMigrations()

Lists unapplied migrations.

public async listPendingMigrations(): Promise<MigrationInfo[]>

public async listPendingMigrations(): Promise<MigrationInfo[]>

migrate()

Runs migrations using the supplied options or defaults to latestlatest.

public async migrate(
    options?: MigrationOptions
): Promise<void>

public async migrate(
    options?: MigrationOptions
): Promise<void>

Parameter: options

Target migration or direction overrides

migrateDown()

Runs a single downwards migration step unless a custom count is provided.

public async migrateDown(
    options?: StepMigrationOptions
): Promise<void>

public async migrateDown(
    options?: StepMigrationOptions
): Promise<void>

Parameter: options

Optional configuration for step-based execution

migrateUp()

Runs a single upwards migration step unless a custom count is provided.

public async migrateUp(
    options?: StepMigrationOptions
): Promise<void>

public async migrateUp(
    options?: StepMigrationOptions
): Promise<void>

Parameter: options

Optional configuration for step-based execution

stop()

Tears down the connection pool and clears the migration manager reference.

public async stop(): Promise<void>

public async stop(): Promise<void>

Classpluginsv0.6.1

KyselyPg

Postgres plugin using Kysely.

Handles setting up the connection pool, applying migrations, and registering decorated services so they can be resolved from the core.

class KyselyPg<Database extends object> extends Plugin

class KyselyPg<Database extends object> extends Plugin

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the KyselyPgKyselyPg class

KyselyPg(core: Core, options: KpgOptions)

KyselyPg(core: Core, options: KpgOptions)

Showing members with Protected visibility and higher.

Properties

connection
core
logger
services

Methods

init()
listMigrations()
listPendingMigrations()
migrate()
migrateDown()
migrateUp()
stop()

Database

Database extends object

Database extends object

connection

Exposed Kysely instance once initinit completes.

public connection: Kysely<Database>

public connection: Kysely<Database>

core

public readonly core: Core

public readonly core: Core

logger

public readonly logger: Logger

public readonly logger: Logger

accessor

services

Map of all services registered with the plugin, keyed by their decorator name.

public get services(): KpgServices

public get services(): KpgServices

init()

Connects to Postgres, runs any startup migrations, and loads decorated services.

Safe to call multiple times; subsequent calls exit early.

public async init(): Promise<void>

public async init(): Promise<void>

listMigrations()

Lists every migration registered with the manager along with its execution state.

public async listMigrations(): Promise<readonly MigrationInfo[]>

public async listMigrations(): Promise<readonly MigrationInfo[]>

listPendingMigrations()

Lists unapplied migrations.

public async listPendingMigrations(): Promise<MigrationInfo[]>

public async listPendingMigrations(): Promise<MigrationInfo[]>

migrate()

Runs migrations using the supplied options or defaults to latestlatest.

public async migrate(
    options?: MigrationOptions
): Promise<void>

public async migrate(
    options?: MigrationOptions
): Promise<void>

Parameter: options

Target migration or direction overrides

migrateDown()

Runs a single downwards migration step unless a custom count is provided.

public async migrateDown(
    options?: StepMigrationOptions
): Promise<void>

public async migrateDown(
    options?: StepMigrationOptions
): Promise<void>

Parameter: options

Optional configuration for step-based execution

migrateUp()

Runs a single upwards migration step unless a custom count is provided.

public async migrateUp(
    options?: StepMigrationOptions
): Promise<void>

public async migrateUp(
    options?: StepMigrationOptions
): Promise<void>

Parameter: options

Optional configuration for step-based execution

stop()

Tears down the connection pool and clears the migration manager reference.

public async stop(): Promise<void>

public async stop(): Promise<void>