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


-- | Provides a quasi-quoter for raw SQL for persistent
--   
--   Please see README and API docs at
--   <a>http://www.stackage.org/package/persistent</a>.
@package persistent-qq
@version 2.9.2.1


-- | Module: module Database.Persist.Sql.Raw.QQ Description: QuasiQuoters
--   for performing raw sql queries
--   
--   This module exports convenient QuasiQuoters to perform raw SQL
--   queries. All QuasiQuoters follow the same pattern and are analogous to
--   the similar named functions exported from <a>Raw</a>. Neither the
--   quoted function's behaviour, nor it's return value is altered during
--   the translation and all documentation provided with it holds.
--   
--   The QuasiQuoters in this module perform a simple substitution on the
--   query text, that allows value substitutions, table name substitutions
--   as well as column name substitutions.
module Database.Persist.Sql.Raw.QQ

-- | Analoguous to <a>rawQuery</a>
queryQQ :: QuasiQuoter

-- | Analoguous to <a>rawQueryRes</a>
queryResQQ :: QuasiQuoter

-- | QuasiQuoter for performing raw sql queries, analoguous to
--   <a>rawSql</a>
--   
--   This and the following are convenient QuasiQuoters to perform raw SQL
--   queries. They each follow the same pattern and are analogous to the
--   similarly named <tt>raw</tt> functions. Neither the quoted function's
--   behaviour, nor it's return value is altered during the translation and
--   all documentation provided with it holds.
--   
--   These QuasiQuoters perform a simple substitution on the query text,
--   that allows value substitutions, table name substitutions as well as
--   column name substitutions.
--   
--   Here is a small example:
--   
--   Given the following simple model:
--   
--   <pre>
--   Category
--     rgt Int default=0
--     lft Int default=0
--     nam Text
--   </pre>
--   
--   We can now execute this raw query:
--   
--   <pre>
--   let lft = 10 :: <a>Int</a>
--       rgt = 20 :: <a>Int</a>
--       width = rgt <a>-</a> lft
--       nams = "first" <a>:|</a> ["second", "third"]
--    in [sqlQQ|
--         DELETE FROM ^{Category} WHERE @{CategoryLft} BETWEEN #{lft} AND #{rgt};
--         UPDATE category SET @{CategoryRgt} = @{CategoryRgt} - #{width} WHERE @{CategoryRgt} &gt; #{rgt};
--         UPDATE category SET @{CategoryLft} = @{CategoryLft} - #{width} WHERE @{CategoryLft} &gt; #{rgt};
--         SELECT ?? FROM ^{Category} WHERE ^{Category}.@{CategoryNam} IN %{nams};
--         INSERT INTO ^{Category}(@{CategoryNam}) VALUES *{<a>Single</a> <a>&lt;$&gt;</a> nams};
--       |]
--   </pre>
--   
--   <ul>
--   <li><tt>^{TableName}</tt> looks up the table's name and escapes
--   it</li>
--   <li><tt>@{ColumnName}</tt> looks up the column's name and properly
--   escapes it</li>
--   <li><tt>#{value}</tt> inserts the value via the usual parameter
--   substitution mechanism</li>
--   <li><tt>%{values}</tt> inserts comma separated values (of a
--   <a>NonEmpty</a> list) (since 2.9.1)</li>
--   <li><tt>*{rows}</tt> inserts a <a>NonEmpty</a> list of tuples for use
--   with a multirow <tt>INSERT</tt> statement (since 2.9.2)</li>
--   </ul>
sqlQQ :: QuasiQuoter

-- | Analoguous to <a>rawExecute</a>
executeQQ :: QuasiQuoter

-- | Analoguous to <a>rawExecuteCount</a>
executeCountQQ :: QuasiQuoter
class ToRow a
toRow :: ToRow a => a -> NonEmpty PersistValue
instance GHC.Show.Show Database.Persist.Sql.Raw.QQ.Token
instance Database.Persist.Class.PersistField.PersistField a => Database.Persist.Sql.Raw.QQ.ToRow (Database.Persist.Sql.Types.Single a)
instance (Database.Persist.Class.PersistField.PersistField a, Database.Persist.Class.PersistField.PersistField b) => Database.Persist.Sql.Raw.QQ.ToRow (a, b)
instance (Database.Persist.Class.PersistField.PersistField a, Database.Persist.Class.PersistField.PersistField b, Database.Persist.Class.PersistField.PersistField c) => Database.Persist.Sql.Raw.QQ.ToRow (a, b, c)
instance (Database.Persist.Class.PersistField.PersistField a, Database.Persist.Class.PersistField.PersistField b, Database.Persist.Class.PersistField.PersistField c, Database.Persist.Class.PersistField.PersistField d) => Database.Persist.Sql.Raw.QQ.ToRow (a, b, c, d)
instance (Database.Persist.Class.PersistField.PersistField a, Database.Persist.Class.PersistField.PersistField b, Database.Persist.Class.PersistField.PersistField c, Database.Persist.Class.PersistField.PersistField d, Database.Persist.Class.PersistField.PersistField e) => Database.Persist.Sql.Raw.QQ.ToRow (a, b, c, d, e)