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


-- | Convert various postgresql-simple calls to work with pipes
--   
--   This library provides a few Producers and Consumers that allow
--   <tt>postgresql-simple</tt> calls to be made within the <tt>pipes</tt>
--   framework. Currently, there is support for:
--   
--   <ul>
--   <li>Streaming queries</li>
--   <li>Streaming entire tables to and from a <tt>ByteString</tt>.</li>
--   </ul>
@package pipes-postgresql-simple
@version 0.1.3.0

module Pipes.PostgreSQL.Simple.SafeT

-- | The PostgreSQL file format, used by the <tt>COPY</tt> command
data Format
Text :: Format
Binary :: Format
CSV :: Format
toTable :: (MonadIO m, MonadSafe m, Base m ~ IO) => Connection -> Format -> String -> Consumer ByteString m a
instance GHC.Show.Show Pipes.PostgreSQL.Simple.SafeT.Format


-- | Pipes utilities built on top of <tt>postgresql-simple</tt>
module Pipes.PostgreSQL.Simple

-- | Convert a query to a <tt>Producer</tt> of rows.
--   
--   For example,
--   
--   <pre>
--   pg &lt;- connectToPostgresql
--   query pg "SELECT * FROM widgets WHERE ID = ?" (Only widgetId) &gt;-&gt; print
--   </pre>
--   
--   Will select all widgets for a given <tt>widgetId</tt>, and then print
--   each row to standard output.
query :: (MonadIO m, FromRow r, ToRow params) => Connection -> Query -> params -> Producer r m ()

-- | Like <a>query</a>, but it doesn't perform any query parameter
--   substitution.
query_ :: (MonadIO m, FromRow r) => Connection -> Query -> Producer r m ()

-- | The PostgreSQL file format, used by the <tt>COPY</tt> command
data Format
Text :: Format
Binary :: Format
CSV :: Format

-- | Convert a table to a byte stream. This is equivilent to a PostgreSQL
--   <tt>COPY ... TO</tt> statement.
--   
--   Returns the number of rows processed.
fromTable :: MonadIO m => Connection -> Format -> String -> Producer ByteString m Int64

-- | Convert a byte stream to a table. This is equivilent to a PostgreSQL
--   <tt>COPY ... FROM</tt> statement.
--   
--   Returns the number of rows processed
toTable :: (MonadCatch m, MonadIO m) => Connection -> Format -> String -> Producer ByteString m () -> m Int64