Classplugin-kysely-postgresv0.1.4

KyselyPostgres

Postgres plugin using Kysely.

Sets up the connection pool, applies migrations, and registers decorated services so the core can resolve them.

class KyselyPostgres extends Plugin<{
    transport: "any";
    runtime: "server";
}>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the KyselyPostgres class

KyselyPostgres(host: CoreBase, options: KyselyOptions)

Showing members with Protected visibility and higher.

Methods

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

connection

Exposed Kysely instance once init completes.

public connection: Kysely<KyselySchema>

runtime

public runtime: 'server'

accessor

services

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

public get services(): KyselyServices

Throws:

A SeedcordError if accessed before the plugin finishes initializing.

transport

public transport: 'any'

dispose()

public async dispose(): Promise<void>

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>

listMigrations()

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

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

listPendingMigrations()

Lists unapplied migrations.

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

migrate()

Runs migrations using the supplied options.

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>

migrateUp()

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

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