Skip to main content
Version: Next

LibSqlConnection

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

inheritedbegin

  • begin(options): Promise<ControlledTransaction<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(options): Promise<void>

  • Establishes connection to database

    Parameters

    • optionaloptions: { skipOnConnect?: boolean }
      • optionalskipOnConnect: boolean

    Returns Promise<void>

inheritedcreateKysely

  • createKysely(): void

  • Returns void

createKyselyDialect

  • createKyselyDialect(options): LibSqlDialect

  • Parameters

    Returns LibSqlDialect

inheritedensureConnection

  • ensureConnection(): Promise<void>

  • Ensure the connection exists, this is used to support lazy connect when using new MikroORM() instead of the async init method.

    Returns Promise<void>

inheritedexecute

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

  • Parameters

    • query: string | RawQueryFragment | NativeQueryBuilder
    • params: readonly unknown[] = []
    • method: get | all | run = 'all'
    • optionalctx: any
    • optionalloggerContext: LoggingOptions

    Returns Promise<T>

executeDump

  • executeDump(source): Promise<void>

  • Execute raw SQL queries, handy from running schema dump loaded from a file. This method doesn't support transactions, as opposed to orm.schema.execute(), which is used internally.

    Parameters

    • source: string

    Returns Promise<void>

inheritedgetClient

  • Returns Kysely<T>

inheritedgetConnectionOptions

  • Returns ConnectionConfig

inheritedgetPlatform

  • Returns Platform

inheritedisConnected

  • isConnected(): Promise<boolean>

  • Are we connected to the database

    Returns Promise<boolean>

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

inheritedstream

  • stream<T>(query, params, ctx, loggerContext): AsyncIterableIterator<T, any, any>

  • Parameters

    Returns AsyncIterableIterator<T, any, any>

inheritedtransactional

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