abstractConnection

Abstract base class for database connections, providing transaction and query execution support.

Hierarchy

• Connection
  • AbstractSqlConnection
  • MongoConnection

Index

Constructors

• constructor

Methods

• begin
• checkConnection
• close
• commit
• connect
• ensureConnection
• execute
• executeDump
• getConnectionOptions
• getNativeClient
• getPlatform
• isConnected
• rollback
• setMetadata
• setPlatform
• transactional

Constructors

constructor

• new Connection(config, options, type): Connection

• Parameters

  • config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

  • optionaloptions: ConnectionOptions

  • type: ConnectionType = 'write'

  Returns Connection

Methods

begin

• begin(options): Promise<any>

• Begins a new database transaction and returns the transaction context.

  ---

  Parameters

  • optionaloptions: { ctx?: any; eventBroadcaster?: TransactionEventBroadcaster; isolationLevel?: IsolationLevel | read uncommitted | read committed | snapshot | repeatable read | serializable; loggerContext?: LogContext; readOnly?: boolean; sessionContext?: SessionContext }

  • optionalctx: any

  • optionaleventBroadcaster: TransactionEventBroadcaster

  • optionalisolationLevel: IsolationLevel | read uncommitted | read committed | snapshot | repeatable read | serializable

  • optionalloggerContext: LogContext

  • optionalreadOnly: boolean

  • optionalsessionContext: SessionContext

  Returns Promise<any>

abstractcheckConnection

• 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 }>

close

• close(force): Promise<void>

• Closes the database connection (aka disconnect)

  ---

  Parameters

  • optionalforce: boolean

  Returns Promise<void>

commit

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

• Commits the given transaction.

  ---

  Parameters

  • ctx: any

  • optionaleventBroadcaster: TransactionEventBroadcaster

  • optionalloggerContext: LogContext

  Returns Promise<void>

abstractconnect

• connect(options): void | Promise<void>

• Establishes connection to database

  ---

  Parameters

  • optionaloptions: { skipOnConnect?: boolean }

  • optionalskipOnConnect: boolean

  Returns void | Promise<void>

ensureConnection

• 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>

abstractexecute

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

• Executes a raw query and returns the result.

  ---

  Parameters

  • query: string

  • optionalparams: any[]

  • optionalmethod: get | all | run

  • optionalctx: any

  Returns Promise<any>

executeDump

• executeDump(dump): 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

  • dump: string

  Returns Promise<void>

getConnectionOptions

• getConnectionOptions(): ConnectionConfig

• Parses and returns the resolved connection configuration (host, port, user, etc.).

  ---

  Returns ConnectionConfig

getNativeClient

• getNativeClient(): Promise<unknown>

• Returns the underlying database client the connection drives — e.g. the pg pool, the better-sqlite3 database, or the PGlite instance — for vendor APIs MikroORM does not wrap. Each driver narrows the return type to its own client. Its lifecycle belongs to the ORM, so leave closing it to orm.close() unless you supplied the client yourself via driverOptions.

  ---

  Returns Promise<unknown>

getPlatform

• getPlatform(): Platform

• Returns the platform abstraction for this connection.

  ---

  Returns Platform

abstractisConnected

• isConnected(): Promise<boolean>

• Are we connected to the database

  ---

  Returns Promise<boolean>

rollback

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

• Rolls back the given transaction.

  ---

  Parameters

  • ctx: any

  • optionaleventBroadcaster: TransactionEventBroadcaster

  • optionalloggerContext: LogContext

  Returns Promise<void>

setMetadata

• setMetadata(metadata): void

• Sets the metadata storage on this connection.

  ---

  Parameters

  • metadata: MetadataStorage

  Returns void

setPlatform

• setPlatform(platform): void

• Sets the platform abstraction on this connection.

  ---

  Parameters

  • platform: Platform

  Returns void

transactional

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

• Executes a callback inside a transaction, committing on success and rolling back on failure.

  ---

  Parameters

  • cb: (trx) => Promise<T>

  • optionaloptions: { ctx?: any; eventBroadcaster?: TransactionEventBroadcaster; isolationLevel?: IsolationLevel | read uncommitted | read committed | snapshot | repeatable read | serializable; loggerContext?: LogContext; readOnly?: boolean; sessionContext?: SessionContext }

  • optionalctx: any

  • optionaleventBroadcaster: TransactionEventBroadcaster

  • optionalisolationLevel: IsolationLevel | read uncommitted | read committed | snapshot | repeatable read | serializable

  • optionalloggerContext: LogContext

  • optionalreadOnly: boolean

  • optionalsessionContext: SessionContext

  Returns Promise<T>