Safe Haskell	None
Language	Haskell2010

Database.PostgreSQL.PQTypes.Internal.Connection

Synopsis

Documentation

Wrapper for hiding representation of a connection object.

Constructors

Connection
Fields unConnection :: MVar (Maybe ConnectionData)

Representation of a connection object.

Constructors

ConnectionData
Fields cdFrgnPtr :: !(ForeignPtr (Ptr PGconn)) Foreign pointer to pointer to connection object. cdPtr :: !(Ptr PGconn) Pointer to connection object (the same as in `cdFrgnPtr`). cdStats :: !ConnectionStats Statistics associated with the connection.

Simple connection statistics.

Constructors

ConnectionStats
Fields statsQueries :: !Int Number of queries executed so far. statsRows :: !Int Number of rows fetched from the database. statsValues :: !Int Number of values fetched from the database. statsParams :: !Int Number of parameters sent to the database.

Instances

Eq ConnectionStats Source #
Methods (==) :: ConnectionStats -> ConnectionStats -> Bool # (/=) :: ConnectionStats -> ConnectionStats -> Bool #
Ord ConnectionStats Source #
Methods compare :: ConnectionStats -> ConnectionStats -> Ordering # (<) :: ConnectionStats -> ConnectionStats -> Bool # (<=) :: ConnectionStats -> ConnectionStats -> Bool # (>) :: ConnectionStats -> ConnectionStats -> Bool # (>=) :: ConnectionStats -> ConnectionStats -> Bool # max :: ConnectionStats -> ConnectionStats -> ConnectionStats # min :: ConnectionStats -> ConnectionStats -> ConnectionStats #
Show ConnectionStats Source #
Methods showsPrec :: Int -> ConnectionStats -> ShowS # show :: ConnectionStats -> String # showList :: [ConnectionStats] -> ShowS #

Constructors

ConnectionSettings
Fields csConnInfo :: !Text Connection info string. csClientEncoding :: !(Maybe Text) Client-side encoding. If set to `Nothing`, database encoding is used. csComposites :: ![Text] A list of composite types to register. In order to be able to (de)serialize specific composite types, you need to register them.

Instances

Eq ConnectionSettings Source #
Methods (==) :: ConnectionSettings -> ConnectionSettings -> Bool # (/=) :: ConnectionSettings -> ConnectionSettings -> Bool #
Ord ConnectionSettings Source #
Methods compare :: ConnectionSettings -> ConnectionSettings -> Ordering # (<) :: ConnectionSettings -> ConnectionSettings -> Bool # (<=) :: ConnectionSettings -> ConnectionSettings -> Bool # (>) :: ConnectionSettings -> ConnectionSettings -> Bool # (>=) :: ConnectionSettings -> ConnectionSettings -> Bool # max :: ConnectionSettings -> ConnectionSettings -> ConnectionSettings # min :: ConnectionSettings -> ConnectionSettings -> ConnectionSettings #
Show ConnectionSettings Source #
Methods showsPrec :: Int -> ConnectionSettings -> ShowS # show :: ConnectionSettings -> String # showList :: [ConnectionSettings] -> ShowS #
Default ConnectionSettings Source #	Default connection settings. Note that all strings sent to PostgreSQL by the library are encoded as UTF-8, so don't alter client encoding unless you know what you're doing.
Methods def :: ConnectionSettings #

def :: Default a => a #

The default value for this type.

Database connection supplier.

Constructors

ConnectionSourceM
Fields withConnection :: forall r. (Connection -> m r) -> m r

Wrapper for a polymorphic connection source.

Constructors

ConnectionSource
Fields unConnectionSource :: forall m. MkConstraint m cs => ConnectionSourceM m

Default connection supplier. It establishes new database connection each time withConnection is called.

Arguments

:: ConnectionSettings
-> Int	Stripe count. The number of distinct sub-pools to maintain. The smallest acceptable value is 1.
-> NominalDiffTime	Amount of time for which an unused database connection is kept open. The smallest acceptable value is 0.5 seconds. The elapsed time before closing database connection may be a little longer than requested, as the reaper thread wakes at 1-second intervals.
-> Int	Maximum number of database connections to keep open per stripe. The smallest acceptable value is 1. Requests for database connections will block if this limit is reached on a single stripe, even if other stripes have idle connections available.
-> IO (ConnectionSource [MonadBase IO, MonadMask])

Pooled source. It uses striped pool from resource-pool package to cache established connections and reuse them.

Low-level function for connecting to the database. Useful if one wants to implement custom connection source.

Low-level function for disconnecting from the database. Useful if one wants to implement custom connection source.