/usr/share/doc/haskell-haskelldb-doc/html/src/Database-HaskellDB-DriverAPI.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 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
<title>src/Database/HaskellDB/DriverAPI.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE ExistentialQuantification, Rank2Types #-}</span>
<a name="line-2"></a><span class='hs-comment'>-----------------------------------------------------------</span>
<a name="line-3"></a><span class='hs-comment'>-- |</span>
<a name="line-4"></a><span class='hs-comment'>-- Module : DriverAPI</span>
<a name="line-5"></a><span class='hs-comment'>-- Copyright : Anders Hockersten (c), chucky@dtek.chalmers.se</span>
<a name="line-6"></a><span class='hs-comment'>-- License : BSD-style</span>
<a name="line-7"></a><span class='hs-comment'>--</span>
<a name="line-8"></a><span class='hs-comment'>-- Maintainer : chucky@dtek.chalmers.se</span>
<a name="line-9"></a><span class='hs-comment'>-- Stability : experimental</span>
<a name="line-10"></a><span class='hs-comment'>-- Portability : portable</span>
<a name="line-11"></a><span class='hs-comment'>--</span>
<a name="line-12"></a><span class='hs-comment'>-- This exports an API that all drivers must conform to. It</span>
<a name="line-13"></a><span class='hs-comment'>-- is used by the end user to load drivers either dynamically</span>
<a name="line-14"></a><span class='hs-comment'>-- or statically.</span>
<a name="line-15"></a><span class='hs-comment'>-----------------------------------------------------------</span>
<a name="line-16"></a>
<a name="line-17"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Database</span><span class='hs-varop'>.</span><span class='hs-conid'>HaskellDB</span><span class='hs-varop'>.</span><span class='hs-conid'>DriverAPI</span> <span class='hs-layout'>(</span>
<a name="line-18"></a> <span class='hs-conid'>DriverInterface</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-19"></a> <span class='hs-conid'>MonadIO</span><span class='hs-layout'>,</span>
<a name="line-20"></a> <span class='hs-varid'>defaultdriver</span><span class='hs-layout'>,</span>
<a name="line-21"></a> <span class='hs-varid'>getOptions</span><span class='hs-layout'>,</span>
<a name="line-22"></a> <span class='hs-varid'>getAnnotatedOptions</span><span class='hs-layout'>,</span>
<a name="line-23"></a> <span class='hs-varid'>getGenerator</span>
<a name="line-24"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-25"></a>
<a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Database</span><span class='hs-varop'>.</span><span class='hs-conid'>HaskellDB</span><span class='hs-varop'>.</span><span class='hs-conid'>Database</span> <span class='hs-layout'>(</span><span class='hs-conid'>Database</span><span class='hs-layout'>)</span>
<a name="line-27"></a>
<a name="line-28"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Database</span><span class='hs-varop'>.</span><span class='hs-conid'>HaskellDB</span><span class='hs-varop'>.</span><span class='hs-conid'>Sql</span><span class='hs-varop'>.</span><span class='hs-conid'>Generate</span> <span class='hs-layout'>(</span><span class='hs-conid'>SqlGenerator</span><span class='hs-layout'>)</span>
<a name="line-29"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Database</span><span class='hs-varop'>.</span><span class='hs-conid'>HaskellDB</span><span class='hs-varop'>.</span><span class='hs-conid'>Sql</span><span class='hs-varop'>.</span><span class='hs-conid'>Default</span> <span class='hs-layout'>(</span><span class='hs-varid'>defaultSqlGenerator</span><span class='hs-layout'>)</span>
<a name="line-30"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Database</span><span class='hs-varop'>.</span><span class='hs-conid'>HaskellDB</span><span class='hs-varop'>.</span><span class='hs-conid'>Sql</span><span class='hs-varop'>.</span><span class='hs-conid'>MySQL</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>MySQL</span>
<a name="line-31"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Database</span><span class='hs-varop'>.</span><span class='hs-conid'>HaskellDB</span><span class='hs-varop'>.</span><span class='hs-conid'>Sql</span><span class='hs-varop'>.</span><span class='hs-conid'>PostgreSQL</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>PostgreSQL</span>
<a name="line-32"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Database</span><span class='hs-varop'>.</span><span class='hs-conid'>HaskellDB</span><span class='hs-varop'>.</span><span class='hs-conid'>Sql</span><span class='hs-varop'>.</span><span class='hs-conid'>SQLite</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>SQLite</span>
<a name="line-33"></a>
<a name="line-34"></a>
<a name="line-35"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span> <span class='hs-layout'>(</span><span class='hs-varid'>liftM</span><span class='hs-layout'>)</span>
<a name="line-36"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span><span class='hs-varop'>.</span><span class='hs-conid'>Trans</span> <span class='hs-layout'>(</span><span class='hs-conid'>MonadIO</span><span class='hs-layout'>)</span>
<a name="line-37"></a>
<a name="line-38"></a><a name="DriverInterface"></a><span class='hs-comment'>-- | Interface which drivers should implement.</span>
<a name="line-39"></a><a name="DriverInterface"></a><span class='hs-comment'>-- The 'connect' function takes some driver specific name, value pairs</span>
<a name="line-40"></a><a name="DriverInterface"></a><span class='hs-comment'>-- use to setup the database connection, and a database action to run.</span>
<a name="line-41"></a><a name="DriverInterface"></a><span class='hs-comment'>-- 'requiredOptions' lists all required options with a short description,</span>
<a name="line-42"></a><a name="DriverInterface"></a><span class='hs-comment'>-- that is printed as help in the DBDirect program.</span>
<a name="line-43"></a><a name="DriverInterface"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>DriverInterface</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DriverInterface</span>
<a name="line-44"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>connect</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyword'>forall</span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span><span class='hs-varop'>.</span> <span class='hs-conid'>MonadIO</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=></span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>String</span><span class='hs-layout'>,</span><span class='hs-conid'>String</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>Database</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span>
<a name="line-45"></a> <span class='hs-varid'>requiredOptions</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>String</span><span class='hs-layout'>,</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-46"></a> <span class='hs-layout'>}</span>
<a name="line-47"></a>
<a name="line-48"></a><a name="defaultdriver"></a><span class='hs-comment'>-- | Default dummy driver, real drivers should overload this</span>
<a name="line-49"></a><span class='hs-definition'>defaultdriver</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>DriverInterface</span>
<a name="line-50"></a><span class='hs-definition'>defaultdriver</span> <span class='hs-keyglyph'>=</span>
<a name="line-51"></a> <span class='hs-conid'>DriverInterface</span> <span class='hs-layout'>{</span>
<a name="line-52"></a> <span class='hs-varid'>connect</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>error</span> <span class='hs-str'>"DriverAPI.connect: not implemented"</span><span class='hs-layout'>,</span>
<a name="line-53"></a> <span class='hs-varid'>requiredOptions</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>error</span> <span class='hs-str'>"DriverAPI.requiredOptions: not implemented"</span><span class='hs-layout'>}</span>
<a name="line-54"></a>
<a name="line-55"></a><a name="getOptions"></a><span class='hs-comment'>-- | Can be used by drivers to get option values from the given</span>
<a name="line-56"></a><span class='hs-comment'>-- list of name, value pairs.</span>
<a name="line-57"></a><span class='hs-definition'>getOptions</span> <span class='hs-keyglyph'>::</span><span class='hs-conid'>Monad</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ names of options to get</span>
<a name="line-58"></a> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>String</span><span class='hs-layout'>,</span><span class='hs-conid'>String</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ options given</span>
<a name="line-59"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ a list of the same length as the first argument</span>
<a name="line-60"></a> <span class='hs-comment'>-- with the values of each option. Fails in the given</span>
<a name="line-61"></a> <span class='hs-comment'>-- monad if any options is not found.</span>
<a name="line-62"></a><span class='hs-definition'>getOptions</span> <span class='hs-conid'>[]</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-conid'>[]</span>
<a name="line-63"></a><span class='hs-definition'>getOptions</span> <span class='hs-layout'>(</span><span class='hs-varid'>x</span><span class='hs-conop'>:</span><span class='hs-varid'>xs</span><span class='hs-layout'>)</span> <span class='hs-varid'>ys</span> <span class='hs-keyglyph'>=</span>
<a name="line-64"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>lookup</span> <span class='hs-varid'>x</span> <span class='hs-varid'>ys</span> <span class='hs-keyword'>of</span>
<a name="line-65"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>fail</span> <span class='hs-varop'>$</span> <span class='hs-str'>"Missing field "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>x</span>
<a name="line-66"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>v</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>liftM</span> <span class='hs-layout'>(</span><span class='hs-varid'>v</span><span class='hs-conop'>:</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-varid'>getOptions</span> <span class='hs-varid'>xs</span> <span class='hs-varid'>ys</span>
<a name="line-67"></a>
<a name="line-68"></a><a name="getAnnotatedOptions"></a><span class='hs-comment'>-- | Can be used by drivers to get option values from the given</span>
<a name="line-69"></a><span class='hs-comment'>-- list of name, value pairs.</span>
<a name="line-70"></a><span class='hs-comment'>-- It is intended for use with the 'requiredOptions' value of the driver.</span>
<a name="line-71"></a><span class='hs-definition'>getAnnotatedOptions</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Monad</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=></span>
<a name="line-72"></a> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>String</span><span class='hs-layout'>,</span><span class='hs-conid'>String</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ names and descriptions of options to get</span>
<a name="line-73"></a> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>String</span><span class='hs-layout'>,</span><span class='hs-conid'>String</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ options given</span>
<a name="line-74"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ a list of the same length as the first argument</span>
<a name="line-75"></a> <span class='hs-comment'>-- with the values of each option. Fails in the given</span>
<a name="line-76"></a> <span class='hs-comment'>-- monad if any options is not found.</span>
<a name="line-77"></a><span class='hs-definition'>getAnnotatedOptions</span> <span class='hs-varid'>opts</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>getOptions</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-varid'>fst</span> <span class='hs-varid'>opts</span><span class='hs-layout'>)</span>
<a name="line-78"></a>
<a name="line-79"></a><a name="getGenerator"></a><span class='hs-comment'>-- | Gets an 'SqlGenerator' from the "generator" option in the given list.</span>
<a name="line-80"></a><span class='hs-comment'>-- Currently available generators: "mysql", "postgresql", "sqlite", "default"</span>
<a name="line-81"></a><span class='hs-definition'>getGenerator</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Monad</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=></span>
<a name="line-82"></a> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>String</span><span class='hs-layout'>,</span><span class='hs-conid'>String</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ options given</span>
<a name="line-83"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-conid'>SqlGenerator</span> <span class='hs-comment'>-- ^ An SQL generator. If there was no</span>
<a name="line-84"></a> <span class='hs-comment'>-- "generator" option, the default is used.</span>
<a name="line-85"></a> <span class='hs-comment'>-- Fails if the generator is unknown</span>
<a name="line-86"></a><span class='hs-definition'>getGenerator</span> <span class='hs-varid'>opts</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>maybe</span> <span class='hs-layout'>(</span><span class='hs-varid'>return</span> <span class='hs-varid'>defaultSqlGenerator</span><span class='hs-layout'>)</span> <span class='hs-varid'>f</span> <span class='hs-varop'>$</span> <span class='hs-varid'>lookup</span> <span class='hs-str'>"generator"</span> <span class='hs-varid'>opts</span>
<a name="line-87"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>f</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>maybe</span> <span class='hs-layout'>(</span><span class='hs-varid'>fail</span> <span class='hs-varid'>msg</span><span class='hs-layout'>)</span> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>lookup</span> <span class='hs-varid'>n</span> <span class='hs-varid'>generators</span>
<a name="line-88"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>msg</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"Unknown SqlGenerator: "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>n</span>
<a name="line-89"></a>
<a name="line-90"></a><a name="generators"></a><span class='hs-definition'>generators</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>String</span><span class='hs-layout'>,</span><span class='hs-conid'>SqlGenerator</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-91"></a><span class='hs-definition'>generators</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-str'>"mysql"</span><span class='hs-layout'>,</span> <span class='hs-conid'>MySQL</span><span class='hs-varop'>.</span><span class='hs-varid'>generator</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-92"></a> <span class='hs-layout'>(</span><span class='hs-str'>"postgresql"</span><span class='hs-layout'>,</span> <span class='hs-conid'>PostgreSQL</span><span class='hs-varop'>.</span><span class='hs-varid'>generator</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-93"></a> <span class='hs-layout'>(</span><span class='hs-str'>"sqlite"</span><span class='hs-layout'>,</span> <span class='hs-conid'>SQLite</span><span class='hs-varop'>.</span><span class='hs-varid'>generator</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-94"></a> <span class='hs-layout'>(</span><span class='hs-str'>"default"</span><span class='hs-layout'>,</span> <span class='hs-varid'>defaultSqlGenerator</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
</pre></body>
</html>
|