Interface DatabaseContract

interface DatabaseContract {
    manager: ConnectionManagerContract;
    primaryConnectionName: string;
    connection(connectionName?: string): ConnectionContract;
    transaction<TResult>(
        handler: (client: ClientSession, db: Db) => Promise<TResult>,
        options?: TransactionOptions,
    ): Promise<TResult>;
}

Properties

manager primaryConnectionName

Methods

connection transaction

Properties

manager

manager: ConnectionManagerContract

Connection manager.

primaryConnectionName

primaryConnectionName: string

Name of the primary connection defined inside config/mongodb.ts.

Methods

connection

transaction

  • transaction<TResult>(
        handler: (client: ClientSession, db: Db) => Promise<TResult>,
        options?: TransactionOptions,
    ): Promise<TResult>

  • Shortcut to Database.connection().transaction()

    Type Parameters

    • TResult

    Parameters

    • handler: (client: ClientSession, db: Db) => Promise<TResult>
    • Optionaloptions: TransactionOptions

    Returns Promise<TResult>

Settings

Member Visibility

On This Page

Properties
Methods