/usr/share/doc/haskell-haskelldb-doc/html/Database-HaskellDB-DBSpec-DBInfo.html is in libghc-haskelldb-doc 2.1.1-2.
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 26 27 28 29 30 31 32 33 34 35 36 | <!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.HaskellDB.DBSpec.DBInfo</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-HaskellDB-DBSpec-DBInfo.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Database-HaskellDB-DBSpec-DBInfo.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">haskelldb-2.1.1: A library of combinators for generating and executing SQL statements.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>non-portable</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Maintainer</th><td>haskelldb-users@lists.sourceforge.net</td></tr><tr><th>Safe Haskell</th><td>None</td></tr></table><p class="caption">Database.HaskellDB.DBSpec.DBInfo</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This is the <a href="core.html">core</a> file of the DBSpec files. It defines
a DBInfo and important functions on it.
</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:DBInfo">DBInfo</a> = <a href="#v:DBInfo">DBInfo</a> {<ul class="subs"><li><a href="#v:dbname">dbname</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li><li><a href="#v:opts">opts</a> :: <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBOptions">DBOptions</a></li><li><a href="#v:tbls">tbls</a> :: [<a href="Database-HaskellDB-DBSpec-DBInfo.html#t:TInfo">TInfo</a>]</li></ul>}</li><li class="src short"><span class="keyword">data</span> <a href="#t:TInfo">TInfo</a> = <a href="#v:TInfo">TInfo</a> {<ul class="subs"><li><a href="#v:tname">tname</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li><li><a href="#v:cols">cols</a> :: [<a href="Database-HaskellDB-DBSpec-DBInfo.html#t:CInfo">CInfo</a>]</li></ul>}</li><li class="src short"><span class="keyword">data</span> <a href="#t:CInfo">CInfo</a> = <a href="#v:CInfo">CInfo</a> {<ul class="subs"><li><a href="#v:cname">cname</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li><li><a href="#v:descr">descr</a> :: <a href="Database-HaskellDB-FieldType.html#t:FieldDesc">FieldDesc</a></li></ul>}</li><li class="src short"><span class="keyword">data</span> <a href="#t:DBOptions">DBOptions</a> = <a href="#v:DBOptions">DBOptions</a> {<ul class="subs"><li><a href="#v:useBString">useBString</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:makeIdent">makeIdent</a> :: <a href="Database-HaskellDB-DBSpec-PPHelpers.html#t:MakeIdentifiers">MakeIdentifiers</a></li></ul>}</li><li class="src short"><a href="#v:makeDBSpec">makeDBSpec</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBOptions">DBOptions</a> -> [<a href="Database-HaskellDB-DBSpec-DBInfo.html#t:TInfo">TInfo</a>] -> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBInfo">DBInfo</a></li><li class="src short"><a href="#v:makeTInfo">makeTInfo</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> [<a href="Database-HaskellDB-DBSpec-DBInfo.html#t:CInfo">CInfo</a>] -> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:TInfo">TInfo</a></li><li class="src short"><a href="#v:makeCInfo">makeCInfo</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="Database-HaskellDB-FieldType.html#t:FieldDesc">FieldDesc</a> -> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:CInfo">CInfo</a></li><li class="src short"><a href="#v:ppDBInfo">ppDBInfo</a> :: <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBInfo">DBInfo</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a></li><li class="src short"><a href="#v:ppTInfo">ppTInfo</a> :: <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:TInfo">TInfo</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a></li><li class="src short"><a href="#v:ppCInfo">ppCInfo</a> :: <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:CInfo">CInfo</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a></li><li class="src short"><a href="#v:ppDBOptions">ppDBOptions</a> :: <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBOptions">DBOptions</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a></li><li class="src short"><a href="#v:dbInfoToDoc">dbInfoToDoc</a> :: <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBInfo">DBInfo</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a></li><li class="src short"><a href="#v:finalizeSpec">finalizeSpec</a> :: <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBInfo">DBInfo</a> -> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBInfo">DBInfo</a></li><li class="src short"><a href="#v:constructNonClashingDBInfo">constructNonClashingDBInfo</a> :: <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBInfo">DBInfo</a> -> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBInfo">DBInfo</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:DBInfo" class="def">DBInfo</a> <a href="src/Database-HaskellDB-DBSpec-DBInfo.html#DBInfo" class="link">Source</a></p><div class="doc"><p>Defines a database layout, top level
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:DBInfo" class="def">DBInfo</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:dbname" class="def">dbname</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></dt><dd class="doc"><p>The name of the database
</p></dd><dt class="src"><a name="v:opts" class="def">opts</a> :: <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBOptions">DBOptions</a></dt><dd class="doc"><p>Any options (i.e whether to use
Bounded Strings)
</p></dd><dt class="src"><a name="v:tbls" class="def">tbls</a> :: [<a href="Database-HaskellDB-DBSpec-DBInfo.html#t:TInfo">TInfo</a>]</dt><dd class="doc"><p>Tables this database contains
</p></dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:DBInfo" class="caption collapser" onclick="toggleSection('i:DBInfo')">Instances</p><div id="section.i:DBInfo" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBInfo">DBInfo</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:TInfo" class="def">TInfo</a> <a href="src/Database-HaskellDB-DBSpec-DBInfo.html#TInfo" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:TInfo" class="def">TInfo</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:tname" class="def">tname</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></dt><dd class="doc"><p>The name of the table
</p></dd><dt class="src"><a name="v:cols" class="def">cols</a> :: [<a href="Database-HaskellDB-DBSpec-DBInfo.html#t:CInfo">CInfo</a>]</dt><dd class="doc"><p>The columns in this table
</p></dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:TInfo" class="caption collapser" onclick="toggleSection('i:TInfo')">Instances</p><div id="section.i:TInfo" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:TInfo">TInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:TInfo">TInfo</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:CInfo" class="def">CInfo</a> <a href="src/Database-HaskellDB-DBSpec-DBInfo.html#CInfo" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:CInfo" class="def">CInfo</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:cname" class="def">cname</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></dt><dd class="doc"><p>The name of this column
</p></dd><dt class="src"><a name="v:descr" class="def">descr</a> :: <a href="Database-HaskellDB-FieldType.html#t:FieldDesc">FieldDesc</a></dt><dd class="doc"><p>The description of this column
</p></dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:CInfo" class="caption collapser" onclick="toggleSection('i:CInfo')">Instances</p><div id="section.i:CInfo" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:CInfo">CInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:CInfo">CInfo</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:DBOptions" class="def">DBOptions</a> <a href="src/Database-HaskellDB-DBSpec-DBInfo.html#DBOptions" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:DBOptions" class="def">DBOptions</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:useBString" class="def">useBString</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></dt><dd class="doc"><p>Use Bounded Strings?
</p></dd><dt class="src"><a name="v:makeIdent" class="def">makeIdent</a> :: <a href="Database-HaskellDB-DBSpec-PPHelpers.html#t:MakeIdentifiers">MakeIdentifiers</a></dt><dd class="doc"><p>Conversion routines from Database identifiers to Haskell identifiers
</p></dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:DBOptions" class="caption collapser" onclick="toggleSection('i:DBOptions')">Instances</p><div id="section.i:DBOptions" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBOptions">DBOptions</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:makeDBSpec" class="def">makeDBSpec</a><a href="src/Database-HaskellDB-DBSpec-DBInfo.html#makeDBSpec" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></td><td class="doc"><p>The name of the Database
</p></td></tr><tr><td class="src">-> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBOptions">DBOptions</a></td><td class="doc"><p>Options
</p></td></tr><tr><td class="src">-> [<a href="Database-HaskellDB-DBSpec-DBInfo.html#t:TInfo">TInfo</a>]</td><td class="doc"><p>Tables
</p></td></tr><tr><td class="src">-> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBInfo">DBInfo</a></td><td class="doc"><p>The generated DBInfo
</p></td></tr></table></div><div class="doc"><p>Creates a DBInfo
</p></div></div><div class="top"><p class="src"><a name="v:makeTInfo" class="def">makeTInfo</a><a href="src/Database-HaskellDB-DBSpec-DBInfo.html#makeTInfo" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></td><td class="doc"><p>The table name
</p></td></tr><tr><td class="src">-> [<a href="Database-HaskellDB-DBSpec-DBInfo.html#t:CInfo">CInfo</a>]</td><td class="doc"><p>Columns
</p></td></tr><tr><td class="src">-> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:TInfo">TInfo</a></td><td class="doc"><p>The generated TInfo
</p></td></tr></table></div><div class="doc"><p>Creates a TInfo
</p></div></div><div class="top"><p class="src"><a name="v:makeCInfo" class="def">makeCInfo</a><a href="src/Database-HaskellDB-DBSpec-DBInfo.html#makeCInfo" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></td><td class="doc"><p>The column name
</p></td></tr><tr><td class="src">-> <a href="Database-HaskellDB-FieldType.html#t:FieldDesc">FieldDesc</a></td><td class="doc"><p>What the column contains
</p></td></tr><tr><td class="src">-> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:CInfo">CInfo</a></td><td class="doc"><p>The generated CInfo
</p></td></tr></table></div><div class="doc"><p>Creates a CInfo
</p></div></div><div class="top"><p class="src"><a name="v:ppDBInfo" class="def">ppDBInfo</a> :: <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBInfo">DBInfo</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a><a href="src/Database-HaskellDB-DBSpec-DBInfo.html#ppDBInfo" class="link">Source</a></p><div class="doc"><p>Pretty prints a DBInfo
</p></div></div><div class="top"><p class="src"><a name="v:ppTInfo" class="def">ppTInfo</a> :: <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:TInfo">TInfo</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a><a href="src/Database-HaskellDB-DBSpec-DBInfo.html#ppTInfo" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:ppCInfo" class="def">ppCInfo</a> :: <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:CInfo">CInfo</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a><a href="src/Database-HaskellDB-DBSpec-DBInfo.html#ppCInfo" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:ppDBOptions" class="def">ppDBOptions</a> :: <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBOptions">DBOptions</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a><a href="src/Database-HaskellDB-DBSpec-DBInfo.html#ppDBOptions" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:dbInfoToDoc" class="def">dbInfoToDoc</a> :: <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBInfo">DBInfo</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/pretty-1.1.1.0/Text-PrettyPrint.html#t:Doc">Doc</a><a href="src/Database-HaskellDB-DBSpec-DBInfo.html#dbInfoToDoc" class="link">Source</a></p><div class="doc"><p>Creates a valid declaration of a DBInfo. The variable name will be the
same as the database name
</p></div></div><div class="top"><p class="src"><a name="v:finalizeSpec" class="def">finalizeSpec</a> :: <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBInfo">DBInfo</a> -> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBInfo">DBInfo</a><a href="src/Database-HaskellDB-DBSpec-DBInfo.html#finalizeSpec" class="link">Source</a></p><div class="doc"><p>Does a final <a href="touching up.html">touching up</a> of a DBInfo before it is used by i.e DBDirect.
This converts any Bounded Strings to ordinary strings if that flag is set.
</p></div></div><div class="top"><p class="src"><a name="v:constructNonClashingDBInfo" class="def">constructNonClashingDBInfo</a> :: <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBInfo">DBInfo</a> -> <a href="Database-HaskellDB-DBSpec-DBInfo.html#t:DBInfo">DBInfo</a><a href="src/Database-HaskellDB-DBSpec-DBInfo.html#constructNonClashingDBInfo" class="link">Source</a></p><div class="doc"><p>Constructs a DBInfo that doesn't cause nameclashes
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
|