Safe Haskell	Safe-Inferred
Language	Haskell2010

Database.PostgreSQL.Simple.Options

Description

A postgresql connection options type and related functions.

Synopsis

data Options = Options {
- host :: Last String
- hostaddr :: Last String
- port :: Last Int
- user :: Last String
- password :: Last String
- dbname :: Last String
- connectTimeout :: Last Int
- clientEncoding :: Last String
- options :: Last String
- fallbackApplicationName :: Last String
- keepalives :: Last Int
- keepalivesIdle :: Last Int
- keepalivesCount :: Last Int
- sslmode :: Last String
- requiressl :: Last Int
- sslcompression :: Last Int
- sslcert :: Last String
- sslkey :: Last String
- sslrootcert :: Last String
- requirepeer :: Last String
- krbsrvname :: Last String
- gsslib :: Last String
- service :: Last String
}
defaultOptions :: Options
toConnectionString :: Options -> ByteString
parseConnectionString :: String -> Either String Options

Documentation

data Options Source #

A postgresql connection options type.

Constructors

Options

Fields

Instances

Instances details

Monoid Options Source #
Instance details Defined in Database.PostgreSQL.Simple.Options Methods mempty :: Options # mappend :: Options -> Options -> Options # mconcat :: [Options] -> Options #
Semigroup Options Source #
Instance details Defined in Database.PostgreSQL.Simple.Options Methods (<>) :: Options -> Options -> Options # sconcat :: NonEmpty Options -> Options # stimes :: Integral b => b -> Options -> Options #
Generic Options Source #
Instance details Defined in Database.PostgreSQL.Simple.Options Associated Types type Rep Options :: Type -> Type # Methods from :: Options -> Rep Options x # to :: Rep Options x -> Options #
Read Options Source #
Instance details Defined in Database.PostgreSQL.Simple.Options Methods readsPrec :: Int -> ReadS Options # readList :: ReadS [Options] # readPrec :: ReadPrec Options # readListPrec :: ReadPrec [Options] #
Show Options Source #
Instance details Defined in Database.PostgreSQL.Simple.Options Methods showsPrec :: Int -> Options -> ShowS # show :: Options -> String # showList :: [Options] -> ShowS #
Eq Options Source #
Instance details Defined in Database.PostgreSQL.Simple.Options Methods (==) :: Options -> Options -> Bool # (/=) :: Options -> Options -> Bool #
Ord Options Source #
Instance details Defined in Database.PostgreSQL.Simple.Options Methods compare :: Options -> Options -> Ordering # (<) :: Options -> Options -> Bool # (<=) :: Options -> Options -> Bool # (>) :: Options -> Options -> Bool # (>=) :: Options -> Options -> Bool # max :: Options -> Options -> Options # min :: Options -> Options -> Options #
type Rep Options Source #
Instance details Defined in Database.PostgreSQL.Simple.Options type Rep Options = D1 ('MetaData "Options" "Database.PostgreSQL.Simple.Options" "postgres-options-0.2.2.0-1E7zjChgd7fCL4QkrESU2W" 'False) (C1 ('MetaCons "Options" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last String)) :: S1 ('MetaSel ('Just "hostaddr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last String))) :: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last Int)) :: (S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last String)) :: S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last String))))) :: ((S1 ('MetaSel ('Just "dbname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last String)) :: (S1 ('MetaSel ('Just "connectTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last Int)) :: S1 ('MetaSel ('Just "clientEncoding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last String)))) :: (S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last String)) :: (S1 ('MetaSel ('Just "fallbackApplicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last String)) :: S1 ('MetaSel ('Just "keepalives") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last Int)))))) :: (((S1 ('MetaSel ('Just "keepalivesIdle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last Int)) :: (S1 ('MetaSel ('Just "keepalivesCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last Int)) :: S1 ('MetaSel ('Just "sslmode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last String)))) :: (S1 ('MetaSel ('Just "requiressl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last Int)) :: (S1 ('MetaSel ('Just "sslcompression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last Int)) :: S1 ('MetaSel ('Just "sslcert") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last String))))) :: ((S1 ('MetaSel ('Just "sslkey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last String)) :: (S1 ('MetaSel ('Just "sslrootcert") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last String)) :: S1 ('MetaSel ('Just "requirepeer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last String)))) :: (S1 ('MetaSel ('Just "krbsrvname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last String)) :: (S1 ('MetaSel ('Just "gsslib") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last String)) :: S1 ('MetaSel ('Just "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last String))))))))

defaultOptions :: Options Source #

Default options.

  defaultOptions :: Options
  defaultOptions = mempty
   { host     = pure "localhost"
   , port     = pure 5432
   , user     = pure "postgres"
   , dbname   = pure "postgres"
   }

toConnectionString :: Options -> ByteString Source #

Make a key value postgresql option string.

parseConnectionString :: String -> Either String Options Source #

Parse a connection string. Can be in URI or keyword format.