Class

PostgresConnection

A Postgres connection. Use it to run queries against a Postgres server.

final class PostgresConnection

Overview

Thread safety is achieved by dispatching all access to shared state onto the underlying EventLoop.

closeFuture
eventLoop
The underlying EventLoop of both the connection and its channel.
id
The connection’s identifier. The identifier is passed to the connection factory method and must stay attached to the connection at all times. It must not change during the connection’s lifetime.
isClosed
logger
A logger to use for background events.

addListener(channel:handler:)
Add a handler for NotificationResponse messages on a certain channel. This is used in conjunction with PostgreSQL’s LISTEN/NOTIFY support: to listen on a channel, you add a listener using this method to handle the NotificationResponse messages, then issue a LISTEN query to instruct PostgreSQL to begin sending NotificationResponse messages.
authenticate(username:database:password:logger:)
closeGracefully()
Closes the connection to the server, after all queries that have been created on this connection have been run.
copyFrom(table:columns:format:logger:file:line:writeData:)
Copy data into a table using a COPY <table name> FROM STDIN query.
execute(_:logger:file:line:)
Execute a prepared statement, taking care of the preparation when necessary.
listen(_:)
Start listening for a channel.
listen(on:consume:)
Listen to a channel and run closure with PostgresNotificationSequence.
query(_:logger:file:line:)
Run a query on the Postgres server the connection is connected to.
query(_:logger:file:line:_:)
Run a query on the Postgres server the connection is connected to and iterate the rows in a callback.
withTransaction(logger:file:line:isolation:_:)
Puts the connection into an open transaction state, for the provided closure’s lifetime.

defaultEventLoopGroup
Returns the default EventLoopGroup singleton, automatically selecting the best for the platform.