PostgreSqlConnection

Hierarchy

• AbstractSqlConnection
  • PostgreSqlConnection

Index

Constructors

• constructor

Methods

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

Constructors

constructor

• new PostgreSqlConnection(config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>, options?: ConnectionOptions, type?: read | write): PostgreSqlConnection

• Inherited from AbstractSqlConnection.constructor

  Parameters

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

  • optionaloptions: ConnectionOptions

  • optionaltype: read | write

  Returns PostgreSqlConnection

Methods

begin

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

• Inherited from AbstractSqlConnection.begin

  Parameters

  • options: { ctx?: Transaction<any, any[]>; eventBroadcaster?: TransactionEventBroadcaster; isolationLevel?: IsolationLevel; readOnly?: boolean } = {}

  • optionalctx: Transaction<any, any[]>

  • optionaleventBroadcaster: TransactionEventBroadcaster

  • optionalisolationLevel: IsolationLevel

  • optionalreadOnly: boolean

  Returns Promise<Transaction<any, any[]>>

checkConnection

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

• Inherited from AbstractSqlConnection.checkConnection

  Are we connected to the database

  ---

  Returns Promise<{ error?: Error; ok: boolean; reason?: string }>

close

• close(force?: boolean): Promise<void>

• Inherited from AbstractSqlConnection.close

  Closes the database connection (aka disconnect)

  ---

  Parameters

  • optionalforce: boolean

  Returns Promise<void>

commit

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

• Inherited from AbstractSqlConnection.commit

  Parameters

  • ctx: Transaction<any, any[]>

  • optionaleventBroadcaster: TransactionEventBroadcaster

  Returns Promise<void>

connect

• connect(): void | Promise<void>

• Inherited from AbstractSqlConnection.connect

  Establishes connection to database

  ---

  Returns void | Promise<void>

createKnex

• createKnex(): void

• Overrides AbstractSqlConnection.createKnex

  Returns void

ensureConnection

• ensureConnection(): Promise<void>

• Inherited from AbstractSqlConnection.ensureConnection

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

  ---

  Returns Promise<void>

execute

• execute<T>(queryOrKnex: string | QueryBuilder<any, any> | Raw<any>, params?: unknown[], method?: get | all | run, ctx?: any, loggerContext?: LoggingOptions): Promise<T>

• Inherited from AbstractSqlConnection.execute

  Type parameters

  • T: QueryResult<{ id: number }> | EntityData<Partial<any>> | EntityData<Partial<any>>[] = EntityData<Partial<any>>[]

  Parameters

  • queryOrKnex: string | QueryBuilder<any, any> | Raw<any>

  • params: unknown[] = []

  • method: get | all | run = 'all'

  • optionalctx: any

  • optionalloggerContext: LoggingOptions

  Returns Promise<T>

getClientUrl

• getClientUrl(): string

• Inherited from AbstractSqlConnection.getClientUrl

  Returns string

getConnectionOptions

• getConnectionOptions(): PgConnectionConfig

• Overrides AbstractSqlConnection.getConnectionOptions

  Returns PgConnectionConfig

getDefaultClientUrl

• getDefaultClientUrl(): string

• Overrides AbstractSqlConnection.getDefaultClientUrl

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

  ---

  Returns string

getKnex

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

• Inherited from AbstractSqlConnection.getKnex

  Returns Knex<any, any[]>

getPlatform

• getPlatform(): Platform

• Inherited from AbstractSqlConnection.getPlatform

  Returns Platform

isConnected

• isConnected(): Promise<boolean>

• Inherited from AbstractSqlConnection.isConnected

  Are we connected to the database

  ---

  Returns Promise<boolean>

loadFile

• loadFile(path: string): Promise<void>

• Inherited from AbstractSqlConnection.loadFile

  Execute raw SQL queries from file

  ---

  Parameters

  • path: string

  Returns Promise<void>

rollback

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

• Inherited from AbstractSqlConnection.rollback

  Parameters

  • ctx: Transaction<any, any[]>

  • optionaleventBroadcaster: TransactionEventBroadcaster

  Returns Promise<void>

setMetadata

• setMetadata(metadata: MetadataStorage): void

• Inherited from AbstractSqlConnection.setMetadata

  Parameters

  • metadata: MetadataStorage

  Returns void

setPlatform

• setPlatform(platform: Platform): void

• Inherited from AbstractSqlConnection.setPlatform

  Parameters

  • platform: Platform

  Returns void

transactional

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

• Inherited from AbstractSqlConnection.transactional

  Type parameters

  • T

  Parameters

  • cb: (trx: Transaction<any, any[]>) => Promise<T>

  • options: { ctx?: Transaction<any, any[]>; eventBroadcaster?: TransactionEventBroadcaster; isolationLevel?: IsolationLevel; readOnly?: boolean } = {}

  • optionalctx: Transaction<any, any[]>

  • optionaleventBroadcaster: TransactionEventBroadcaster

  • optionalisolationLevel: IsolationLevel

  • optionalreadOnly: boolean

  Returns Promise<T>