-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | PostgreSQL backend for the Selda database EDSL.
--   
--   PostgreSQL backend for the Selda database EDSL. Requires the
--   PostgreSQL <tt>libpq</tt> development libraries to be installed.
@package selda-postgresql
@version 0.1.2.1


-- | PostgreSQL backend for Selda.
module Database.Selda.PostgreSQL

-- | PostgreSQL connection information.
data PGConnectInfo
PGConnectInfo :: Text -> Int -> Text -> Maybe Text -> Maybe Text -> PGConnectInfo

-- | Host to connect to.
[pgHost] :: PGConnectInfo -> Text

-- | Port to connect to.
[pgPort] :: PGConnectInfo -> Int

-- | Name of database to use.
[pgDatabase] :: PGConnectInfo -> Text

-- | Username for authentication, if necessary.
[pgUsername] :: PGConnectInfo -> Maybe Text

-- | Password for authentication, if necessary.
[pgPassword] :: PGConnectInfo -> Maybe Text

-- | Perform the given computation over a PostgreSQL database. The database
--   connection is guaranteed to be closed when the computation terminates.
withPostgreSQL :: (MonadIO m, MonadThrow m, MonadMask m) => PGConnectInfo -> SeldaT m a -> m a

-- | Connect to the given database on the given host, on the default
--   PostgreSQL port (5432):
--   
--   <pre>
--   withPostgreSQL ("my_db" `on` "example.com") $ do
--     ...
--   </pre>
on :: Text -> Text -> PGConnectInfo
infixl 7 `on`

-- | Add the given username and password to the given connection
--   information:
--   
--   <pre>
--   withPostgreSQL ("my_db" `on` "example.com" `auth` ("user", "pass")) $ do
--     ...
--   </pre>
--   
--   For more precise control over the connection options, you should
--   modify the <a>PGConnectInfo</a> directly.
auth :: PGConnectInfo -> (Text, Text) -> PGConnectInfo
infixl 4 `auth`

-- | Create a <a>SeldaBackend</a> for PostgreSQL <a>Connection</a>
pgBackend :: Connection -> SeldaBackend

-- | Convert <a>PGConnectInfo</a> into <tt>ByteString</tt>
pgConnString :: PGConnectInfo -> ByteString