Class KyselyDatabase<DBSchema>

Represents a database connection using the Kysely library with support for transactions.

Type Parameters

DBSchema = never
The schema type for the database.

Hierarchy (View Summary)

Database<KyselyTransaction<DBSchema>>
- KyselyDatabase

Index

Constructors

Properties

client config readClient?

Methods

Constructors

constructor

new KyselyDatabase<DBSchema = never>(
config: DbConfig<"kysely">,
): KyselyDatabase<DBSchema>
Constructor for creating a database connection using the provided configuration.
Type Parameters
- DBSchema = never
Parameters
- config: DbConfig<"kysely">
  The configuration object for the database connection.
Returns KyselyDatabase<DBSchema>
None
Overrides Database.constructor
- Defined in src/Database/integrations/kysely/KyselyDatabase.ts:52

Properties

`Readonly`client

client: Kysely<DBSchema>

Represents a client for querying the database with the specified schema.

`Readonly`config

config: { type: any }

The database configuration object.

`Optional` `Readonly`readClient

readClient?: Kysely<DBSchema>

Represents a client for reading from the database.

Methods

transaction

transaction(): Promise<KyselyTransaction<DBSchema>>
Override method that starts a new transaction using the provided client and read client.

Returns Promise<KyselyTransaction<DBSchema>>
A Promise that resolves to a KyselyTransaction object for the specified database schema.
Overrides Database.transaction
- Defined in src/Database/integrations/kysely/KyselyDatabase.ts:66