/usr/share/doc/libghc-postgresql-simple-doc/html/Database-PostgreSQL-Simple-ToField.html is in libghc-postgresql-simple-doc 0.4.0.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Database.PostgreSQL.Simple.ToField</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Database-PostgreSQL-Simple-ToField.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Database-PostgreSQL-Simple-ToField.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">postgresql-simple-0.4.0.2: Mid-Level PostgreSQL client library</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Stability</th><td>experimental</td></tr><tr><th>Maintainer</th><td>Leon P Smith <leon@melding-monads.com></td></tr><tr><th>Safe Haskell</th><td>None</td></tr></table><p class="caption">Database.PostgreSQL.Simple.ToField</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>The <code><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a></code> typeclass, for rendering a parameter to a SQL query.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:Action">Action</a> <ul class="subs"><li>= <a href="#v:Plain">Plain</a> <a href="/usr/share/doc/libghc-blaze-builder-doc/html/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a> </li><li>| <a href="#v:Escape">Escape</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> </li><li>| <a href="#v:EscapeByteA">EscapeByteA</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> </li><li>| <a href="#v:Many">Many</a> [<a href="Database-PostgreSQL-Simple-ToField.html#t:Action">Action</a>] </li></ul></li><li class="src short"><span class="keyword">class</span> <a href="#t:ToField">ToField</a> a <span class="keyword">where</span><ul class="subs"><li><a href="#v:toField">toField</a> :: a -> <a href="Database-PostgreSQL-Simple-ToField.html#t:Action">Action</a></li></ul></li><li class="src short"><a href="#v:toJSONField">toJSONField</a> :: <a href="/usr/share/doc/libghc-aeson-doc/html/Data-Aeson-Types.html#t:ToJSON">ToJSON</a> a => a -> <a href="Database-PostgreSQL-Simple-ToField.html#t:Action">Action</a></li><li class="src short"><a href="#v:inQuotes">inQuotes</a> :: <a href="/usr/share/doc/libghc-blaze-builder-doc/html/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a> -> <a href="/usr/share/doc/libghc-blaze-builder-doc/html/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Action" class="def">Action</a> <a href="src/Database-PostgreSQL-Simple-ToField.html#Action" class="link">Source</a></p><div class="doc"><p>How to render an element when substituting it into a query.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Plain" class="def">Plain</a> <a href="/usr/share/doc/libghc-blaze-builder-doc/html/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a></td><td class="doc"><p>Render without escaping or quoting. Use for non-text types
such as numbers, when you are <em>certain</em> that they will not
introduce formatting vulnerabilities via use of characters such
as spaces or "<code>'</code>".
</p></td></tr><tr><td class="src"><a name="v:Escape" class="def">Escape</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a></td><td class="doc"><p>Escape and enclose in quotes before substituting. Use for all
text-like types, and anything else that may contain unsafe
characters when rendered.
</p></td></tr><tr><td class="src"><a name="v:EscapeByteA" class="def">EscapeByteA</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a></td><td class="doc"><p>Escape binary data for use as a <code>bytea</code> literal. Include surrounding
quotes. This is used by the <code><a href="Database-PostgreSQL-Simple-Types.html#t:Binary">Binary</a></code> newtype wrapper.
</p></td></tr><tr><td class="src"><a name="v:Many" class="def">Many</a> [<a href="Database-PostgreSQL-Simple-ToField.html#t:Action">Action</a>]</td><td class="doc"><p>Concatenate a series of rendering actions.
</p></td></tr></table></div><div class="subs instances"><p id="control.i:Action" class="caption collapser" onclick="toggleSection('i:Action')">Instances</p><div id="section.i:Action" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Text-Show.html#t:Show">Show</a> <a href="Database-PostgreSQL-Simple-ToField.html#t:Action">Action</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Typeable-Internal.html#t:Typeable">Typeable</a> <a href="Database-PostgreSQL-Simple-ToField.html#t:Action">Action</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="Database-PostgreSQL-Simple-ToField.html#t:Action">Action</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a name="t:ToField" class="def">ToField</a> a <span class="keyword">where</span><a href="src/Database-PostgreSQL-Simple-ToField.html#ToField" class="link">Source</a></p><div class="doc"><p>A type that may be used as a single parameter to a SQL query.
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:toField" class="def">toField</a> :: a -> <a href="Database-PostgreSQL-Simple-ToField.html#t:Action">Action</a><a href="src/Database-PostgreSQL-Simple-ToField.html#toField" class="link">Source</a></p><div class="doc"><p>Prepare a value for substitution into a query string.
</p></div></div><div class="subs instances"><p id="control.i:ToField" class="caption collapser" onclick="toggleSection('i:ToField')">Instances</p><div id="section.i:ToField" class="show"><table><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Bool.html#t:Bool">Bool</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Prelude.html#t:Double">Double</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Prelude.html#t:Float">Float</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int8">Int8</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int16">Int16</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int32">Int32</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int64">Int64</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Prelude.html#t:Integer">Integer</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Word.html#t:Word">Word</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Word.html#t:Word8">Word8</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Word.html#t:Word16">Word16</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Word.html#t:Word32">Word32</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Word.html#t:Word64">Word64</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/time-1.4.0.1/Data-Time-Clock.html#t:UTCTime">UTCTime</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/libghc-aeson-doc/html/Data-Aeson-Types.html#t:Value">Value</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Lazy-Internal.html#t:Text">Text</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="Database-PostgreSQL-Simple-Types.html#t:Oid">Oid</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/time-1.4.0.1/Data-Time-LocalTime.html#t:LocalTime">LocalTime</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/time-1.4.0.1/Data-Time-LocalTime.html#t:ZonedTime">ZonedTime</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/time-1.4.0.1/Data-Time-LocalTime.html#t:TimeOfDay">TimeOfDay</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/ghc-doc/html/libraries/time-1.4.0.1/Data-Time-Calendar.html#t:Day">Day</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="/usr/share/doc/libghc-uuid-doc/html/Data-UUID.html#t:UUID">UUID</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="Database-PostgreSQL-Simple-Time.html#t:Date">Date</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="Database-PostgreSQL-Simple-Time.html#t:ZonedTimestamp">ZonedTimestamp</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="Database-PostgreSQL-Simple-Time.html#t:UTCTimestamp">UTCTimestamp</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="Database-PostgreSQL-Simple-Time.html#t:LocalTimestamp">LocalTimestamp</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="Database-PostgreSQL-Simple-Types.html#t:Default">Default</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="Database-PostgreSQL-Simple-Types.html#t:Null">Null</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="Database-PostgreSQL-Simple-ToField.html#t:Action">Action</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="Database-PostgreSQL-Simple-HStore.html#t:HStoreMap">HStoreMap</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="Database-PostgreSQL-Simple-HStore.html#t:HStoreList">HStoreList</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> <a href="Database-PostgreSQL-Simple-HStore.html#t:HStoreBuilder">HStoreBuilder</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Char.html#t:Char">Char</a>]</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> a => <a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> a => <a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> (<a href="/usr/share/doc/libghc-vector-doc/html/Data-Vector.html#t:Vector">Vector</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> a => <a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> (<a href="Database-PostgreSQL-Simple-Types.html#t:PGArray">PGArray</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> (<a href="Database-PostgreSQL-Simple-Types.html#t:Binary">Binary</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a>)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> (<a href="Database-PostgreSQL-Simple-Types.html#t:Binary">Binary</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString-Lazy.html#t:ByteString">ByteString</a>)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> a => <a href="Database-PostgreSQL-Simple-ToField.html#t:ToField">ToField</a> (<a href="Database-PostgreSQL-Simple-Types.html#t:In">In</a> [a])</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:toJSONField" class="def">toJSONField</a> :: <a href="/usr/share/doc/libghc-aeson-doc/html/Data-Aeson-Types.html#t:ToJSON">ToJSON</a> a => a -> <a href="Database-PostgreSQL-Simple-ToField.html#t:Action">Action</a><a href="src/Database-PostgreSQL-Simple-ToField.html#toJSONField" class="link">Source</a></p><div class="doc"><p>Convert a Haskell value to a JSON <code><a href="/usr/share/doc/libghc-aeson-doc/html/Data-Aeson-Types.html#t:Value">Value</a></code> using
<code><a href="/usr/share/doc/libghc-aeson-doc/html/Data-Aeson-Types.html#v:toJSON">toJSON</a></code> and convert that to a field using <code><a href="Database-PostgreSQL-Simple-ToField.html#v:toField">toField</a></code>.
</p><p>This can be used as the default implementation for the <code><a href="Database-PostgreSQL-Simple-ToField.html#v:toField">toField</a></code>
method for Haskell types that have a JSON representation in
PostgreSQL.
</p></div></div><div class="top"><p class="src"><a name="v:inQuotes" class="def">inQuotes</a> :: <a href="/usr/share/doc/libghc-blaze-builder-doc/html/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a> -> <a href="/usr/share/doc/libghc-blaze-builder-doc/html/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a><a href="src/Database-PostgreSQL-Simple-ToField.html#inQuotes" class="link">Source</a></p><div class="doc"><p>Surround a string with single-quote characters: "<code>'</code>"
</p><p>This function <em>does not</em> perform any other escaping.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.13.2</p></div></body></html>
|