abstractConnection

Hierarchy

• Connection
  • AbstractSqlConnection
  • MongoConnection

Index

Constructors

• constructor

Methods

• begin
• checkConnection
• close
• commit
• connect
• ensureConnection
• execute
• getClientUrl
• getConnectionOptions
• getDefaultClientUrl
• getPlatform
• isConnected
• rollback
• setMetadata
• setPlatform
• transactional

Constructors

constructor

• new Connection(config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>, options?: ConnectionOptions, type?: ConnectionType): Connection

• Parameters

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

  • optionaloptions: ConnectionOptions

  • type: ConnectionType = 'write'

  Returns Connection

Methods

begin

• begin(options?: { ctx?: any; eventBroadcaster?: TransactionEventBroadcaster; isolationLevel?: IsolationLevel; readOnly?: boolean }): Promise<any>

• Parameters

  • optionaloptions: { ctx?: any; eventBroadcaster?: TransactionEventBroadcaster; isolationLevel?: IsolationLevel; readOnly?: boolean }

  • optionalctx: any

  • optionaleventBroadcaster: TransactionEventBroadcaster

  • optionalisolationLevel: IsolationLevel

  • optionalreadOnly: boolean

  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?: boolean): Promise<void>

• Closes the database connection (aka disconnect)

  ---

  Parameters

  • optionalforce: boolean

  Returns Promise<void>

commit

• commit(ctx: any, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>

• Parameters

  • ctx: any

  • optionaleventBroadcaster: TransactionEventBroadcaster

  Returns Promise<void>

abstractconnect

• connect(): void | Promise<void>

• Establishes connection to database

  ---

  Returns void | Promise<void>

ensureConnection

• ensureConnection(): Promise<void>

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

  ---

  Returns Promise<void>

abstractexecute

• execute(query: string, params?: any[], method?: get | all | run, ctx?: any): Promise<any>

• Parameters

  • query: string

  • optionalparams: any[]

  • optionalmethod: get | all | run

  • optionalctx: any

  Returns Promise<any>

getClientUrl

• getClientUrl(): string

• Returns string

getConnectionOptions

• getConnectionOptions(): ConnectionConfig

• Returns ConnectionConfig

abstractgetDefaultClientUrl

• getDefaultClientUrl(): string

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

  ---

  Returns string

getPlatform

• getPlatform(): Platform

• Returns Platform

abstractisConnected

• isConnected(): Promise<boolean>

• Are we connected to the database

  ---

  Returns Promise<boolean>

rollback

• rollback(ctx: any, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>

• Parameters

  • ctx: any

  • optionaleventBroadcaster: TransactionEventBroadcaster

  Returns Promise<void>

setMetadata

• setMetadata(metadata: MetadataStorage): void

• Parameters

  • metadata: MetadataStorage

  Returns void

setPlatform

• setPlatform(platform: Platform): void

• Parameters

  • platform: Platform

  Returns void

transactional

• transactional(cb: (trx: any) => Promise<T>, options?: { ctx?: any; eventBroadcaster?: TransactionEventBroadcaster; isolationLevel?: IsolationLevel; readOnly?: boolean }): Promise<T>

• Parameters

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

  • optionaloptions: { ctx?: any; eventBroadcaster?: TransactionEventBroadcaster; isolationLevel?: IsolationLevel; readOnly?: boolean }

  • optionalctx: any

  • optionaleventBroadcaster: TransactionEventBroadcaster

  • optionalisolationLevel: IsolationLevel

  • optionalreadOnly: boolean

  Returns Promise<T>