@@ -42,17 +42,22 @@ import Generics.SOP (K(..))
4242import Squeal.PostgreSQL.PQ
4343import Squeal.PostgreSQL.Schema
4444
45−-- | `PoolPQ` @schema@ should be a drop-in replacement for
46−-- `PQ schema schema`.
45+-- | `PoolPQ` @schema@ should be a drop-in replacement for `PQ` @schema schema@.
4746newtype PoolPQ (schema :: TablesType) m x =
4847 PoolPQ { runPoolPQ :: Pool (K Connection schema) -> m x }
4948 deriving Functor
5049
50+-- | Create a striped pool of connections.
51+-- Although the garbage collector will destroy all idle connections when the pool is garbage collected it's recommended to manually destroyAllResources when you're done with the pool so that the connections are freed up as soon as possible.
5152createConnectionPool
52− -- ^ Create a striped pool of connections.
53− -- Although the garbage collector will destroy all idle connections when the pool is garbage collected it's recommended to manually destroyAllResources when you're done with the pool so that the connections are freed up as soon as possible.
5453 :: MonadBase IO io
55− => ByteString -- ^ conninfo
54+ => ByteString
55+ -- ^ The passed string can be empty to use all default parameters, or it can
56+ -- contain one or more parameter settings separated by whitespace.
57+ -- Each parameter setting is in the form keyword = value. Spaces around the equal
58+ -- sign are optional. To write an empty value or a value containing spaces,
59+ -- surround it with single quotes, e.g., keyword = 'a value'. Single quotes and
60+ -- backslashes within the value must be escaped with a backslash, i.e., ' and \.
5661 -> Int
5762 -- ^ The number of stripes (distinct sub-pools) to maintain. The smallest acceptable value is 1.
5863 -> NominalDiffTime