Skip to main content
Version: Next

PostgreSqlConnection

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

inheritedbegin

  • begin(options): Promise<Transaction<any, any[]>>

inheritedcheckConnection

  • checkConnection(): Promise<{ ok: true } | { error?: Error; ok: false; reason: string }>

  • Are we connected to the database

    Returns Promise<{ ok: true } | { error?: Error; ok: false; reason: string }>

inheritedclose

  • close(force): Promise<void>

  • Closes the database connection (aka disconnect)

    Parameters

    • optionalforce: boolean

    Returns Promise<void>

inheritedcommit

  • commit(ctx, eventBroadcaster, loggerContext): Promise<void>

  • Parameters

    Returns Promise<void>

inheritedconnect

  • connect(): void | Promise<void>

  • Establishes connection to database

    Returns void | Promise<void>

createKnex

  • createKnex(): void

  • Returns void

inheritedensureConnection

  • ensureConnection(): Promise<void>

  • Ensure the connection exists, this is used to support lazy connect when using MikroORM.initSync()

    Returns Promise<void>

inheritedexecute

  • execute<T>(queryOrKnex, params, method, ctx, loggerContext): Promise<T>

  • Parameters

    • queryOrKnex: string | QueryBuilder<any, any> | Raw<any>
    • params: unknown[] = []
    • method: get | all | run = 'all'
    • optionalctx: any
    • optionalloggerContext: LoggingOptions

    Returns Promise<T>

inheritedgetClientUrl

  • getClientUrl(): string

  • Returns string

getConnectionOptions

  • getConnectionOptions(): PgConnectionConfig

  • Returns PgConnectionConfig

getDefaultClientUrl

  • getDefaultClientUrl(): string

  • Returns default client url for given driver (e.g. mongodb://127.0.0.1:27017 for mongodb)

    Returns string

inheritedgetKnex

  • getKnex(): Knex<any, any[]>

  • Returns Knex<any, any[]>

inheritedgetPlatform

  • Returns Platform

inheritedisConnected

  • isConnected(): Promise<boolean>

  • Are we connected to the database

    Returns Promise<boolean>

inheritedloadFile

  • loadFile(path): Promise<void>

  • Execute raw SQL queries from file

    Parameters

    • path: string

    Returns Promise<void>

inheritedrollback

  • rollback(ctx, eventBroadcaster, loggerContext): Promise<void>

  • Parameters

    Returns Promise<void>

inheritedsetMetadata

  • setMetadata(metadata): void

  • Parameters

    Returns void

inheritedsetPlatform

  • setPlatform(platform): void

  • Parameters

    Returns void

inheritedtransactional

  • transactional<T>(cb, options): Promise<T>
Page Options