/usr/share/doc/libghc-hdbc-session-doc/html/src/Database-HDBC-Session.html is in libghc-hdbc-session-doc 0.1.1.0-3.
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 106 107 108 109 110 111 112 | <?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/HDBC/Session.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE Rank2Types #-}</span>
<a name="line-2"></a>
<a name="line-3"></a><span class='hs-comment'>-- |</span>
<a name="line-4"></a><span class='hs-comment'>-- Module : Database.HDBC.Session</span>
<a name="line-5"></a><span class='hs-comment'>-- Copyright : 2013-2016 Kei Hibino</span>
<a name="line-6"></a><span class='hs-comment'>-- License : BSD3</span>
<a name="line-7"></a><span class='hs-comment'>--</span>
<a name="line-8"></a><span class='hs-comment'>-- Maintainer : ex8k.hibino@gmail.com</span>
<a name="line-9"></a><span class='hs-comment'>-- Stability : experimental</span>
<a name="line-10"></a><span class='hs-comment'>-- Portability : unknown</span>
<a name="line-11"></a><span class='hs-comment'>--</span>
<a name="line-12"></a><span class='hs-comment'>-- This module provides a base bracketed function</span>
<a name="line-13"></a><span class='hs-comment'>-- to call close correctly against opend DB connection.</span>
<a name="line-14"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Database</span><span class='hs-varop'>.</span><span class='hs-conid'>HDBC</span><span class='hs-varop'>.</span><span class='hs-conid'>Session</span> <span class='hs-layout'>(</span>
<a name="line-15"></a> <span class='hs-comment'>-- * Bracketed session</span>
<a name="line-16"></a> <span class='hs-comment'>-- $bracketedSession</span>
<a name="line-17"></a> <span class='hs-varid'>withConnectionCommit</span><span class='hs-layout'>,</span>
<a name="line-18"></a> <span class='hs-varid'>withConnectionIO</span><span class='hs-layout'>,</span> <span class='hs-varid'>withConnectionIO'</span><span class='hs-layout'>,</span>
<a name="line-19"></a>
<a name="line-20"></a> <span class='hs-varid'>withConnection</span><span class='hs-layout'>,</span>
<a name="line-21"></a>
<a name="line-22"></a> <span class='hs-comment'>-- * Show errors</span>
<a name="line-23"></a> <span class='hs-comment'>-- $showErrors</span>
<a name="line-24"></a> <span class='hs-varid'>showSqlError</span><span class='hs-layout'>,</span> <span class='hs-varid'>handleSqlError'</span>
<a name="line-25"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-26"></a>
<a name="line-27"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Database</span><span class='hs-varop'>.</span><span class='hs-conid'>HDBC</span> <span class='hs-layout'>(</span><span class='hs-conid'>IConnection</span><span class='hs-layout'>,</span> <span class='hs-varid'>handleSql</span><span class='hs-layout'>,</span>
<a name="line-28"></a> <span class='hs-conid'>SqlError</span><span class='hs-layout'>(</span><span class='hs-varid'>seState</span><span class='hs-layout'>,</span> <span class='hs-varid'>seNativeError</span><span class='hs-layout'>,</span> <span class='hs-varid'>seErrorMsg</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-29"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Database</span><span class='hs-varop'>.</span><span class='hs-conid'>HDBC</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>HDBC</span>
<a name="line-30"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Exception</span> <span class='hs-layout'>(</span><span class='hs-varid'>bracket</span><span class='hs-layout'>)</span>
<a name="line-31"></a>
<a name="line-32"></a>
<a name="line-33"></a><span class='hs-comment'>{- $bracketedSession
<a name="line-34"></a>Bracket function implementation is provided by several packages,
<a name="line-35"></a>so this package provides base implementation which requires
<a name="line-36"></a>bracket function and corresponding lift function.
<a name="line-37"></a>-}</span>
<a name="line-38"></a>
<a name="line-39"></a><span class='hs-comment'>{- $showErrors
<a name="line-40"></a>Functions to show 'SqlError' type not to show 'String' fields.
<a name="line-41"></a>-}</span>
<a name="line-42"></a>
<a name="line-43"></a><a name="showSqlError"></a><span class='hs-comment'>-- | show 'SqlError' not to show 'String' fields.</span>
<a name="line-44"></a><span class='hs-definition'>showSqlError</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SqlError</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span>
<a name="line-45"></a><span class='hs-definition'>showSqlError</span> <span class='hs-varid'>se</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unlines</span>
<a name="line-46"></a> <span class='hs-keyglyph'>[</span><span class='hs-str'>"seState: '"</span> <span class='hs-varop'>++</span> <span class='hs-varid'>seState</span> <span class='hs-varid'>se</span> <span class='hs-varop'>++</span> <span class='hs-str'>"'"</span><span class='hs-layout'>,</span>
<a name="line-47"></a> <span class='hs-str'>"seNativeError: "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>show</span> <span class='hs-layout'>(</span><span class='hs-varid'>seNativeError</span> <span class='hs-varid'>se</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-48"></a> <span class='hs-str'>"seErrorMsg: '"</span> <span class='hs-varop'>++</span> <span class='hs-varid'>seErrorMsg</span> <span class='hs-varid'>se</span> <span class='hs-varop'>++</span> <span class='hs-str'>"'"</span><span class='hs-keyglyph'>]</span>
<a name="line-49"></a>
<a name="line-50"></a><a name="handleSqlError'"></a><span class='hs-comment'>-- | Like 'handleSqlError', but not to show 'String' fields of SqlError.</span>
<a name="line-51"></a><span class='hs-definition'>handleSqlError'</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span>
<a name="line-52"></a><span class='hs-definition'>handleSqlError'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>handleSql</span> <span class='hs-layout'>(</span><span class='hs-varid'>fail</span> <span class='hs-varop'>.</span> <span class='hs-varid'>reformat</span> <span class='hs-varop'>.</span> <span class='hs-varid'>showSqlError</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-53"></a> <span class='hs-varid'>reformat</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-str'>"SQL error: \n"</span> <span class='hs-varop'>++</span><span class='hs-layout'>)</span> <span class='hs-varop'>.</span> <span class='hs-varid'>unlines</span> <span class='hs-varop'>.</span> <span class='hs-varid'>map</span> <span class='hs-layout'>(</span><span class='hs-str'>" "</span> <span class='hs-varop'>++</span><span class='hs-layout'>)</span> <span class='hs-varop'>.</span> <span class='hs-varid'>lines</span>
<a name="line-54"></a>
<a name="line-55"></a><a name="withConnection"></a><span class='hs-comment'>-- | Run a transaction on a HDBC IConnection and close the connection.</span>
<a name="line-56"></a><span class='hs-definition'>withConnection</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Monad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>IConnection</span> <span class='hs-varid'>conn</span><span class='hs-layout'>)</span>
<a name="line-57"></a> <span class='hs-keyglyph'>=></span> <span class='hs-layout'>(</span><span class='hs-keyword'>forall</span> <span class='hs-varid'>c</span><span class='hs-varop'>.</span> <span class='hs-varid'>m</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>c</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> <span class='hs-comment'>-- ^ bracket</span>
<a name="line-58"></a> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-keyword'>forall</span> <span class='hs-varid'>b</span><span class='hs-varop'>.</span> <span class='hs-conid'>IO</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-comment'>-- ^ lift</span>
<a name="line-59"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>conn</span> <span class='hs-comment'>-- ^ Connect action</span>
<a name="line-60"></a> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>conn</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-comment'>-- ^ Transaction body</span>
<a name="line-61"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span>
<a name="line-62"></a><span class='hs-definition'>withConnection</span> <span class='hs-varid'>bracket'</span> <span class='hs-varid'>lift</span> <span class='hs-varid'>connect</span> <span class='hs-varid'>tbody</span> <span class='hs-keyglyph'>=</span>
<a name="line-63"></a> <span class='hs-varid'>bracket'</span> <span class='hs-layout'>(</span><span class='hs-varid'>lift</span> <span class='hs-varid'>open'</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>lift</span> <span class='hs-varop'>.</span> <span class='hs-varid'>close'</span><span class='hs-layout'>)</span> <span class='hs-varid'>bodyWithRollback</span>
<a name="line-64"></a> <span class='hs-keyword'>where</span>
<a name="line-65"></a> <span class='hs-varid'>open'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>handleSqlError'</span> <span class='hs-varid'>connect</span>
<a name="line-66"></a> <span class='hs-varid'>close'</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IConnection</span> <span class='hs-varid'>conn</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>conn</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-67"></a> <span class='hs-varid'>close'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>handleSqlError'</span> <span class='hs-varop'>.</span> <span class='hs-conid'>HDBC</span><span class='hs-varop'>.</span><span class='hs-varid'>disconnect</span>
<a name="line-68"></a> <span class='hs-varid'>bodyWithRollback</span> <span class='hs-varid'>conn</span> <span class='hs-keyglyph'>=</span>
<a name="line-69"></a> <span class='hs-varid'>bracket'</span>
<a name="line-70"></a> <span class='hs-layout'>(</span><span class='hs-varid'>return</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-71"></a> <span class='hs-comment'>-- Do rollback independent from driver default behavior when disconnect.</span>
<a name="line-72"></a> <span class='hs-layout'>(</span><span class='hs-varid'>const</span> <span class='hs-varop'>.</span> <span class='hs-varid'>lift</span> <span class='hs-varop'>.</span> <span class='hs-varid'>handleSqlError'</span> <span class='hs-varop'>$</span> <span class='hs-conid'>HDBC</span><span class='hs-varop'>.</span><span class='hs-varid'>rollback</span> <span class='hs-varid'>conn</span><span class='hs-layout'>)</span>
<a name="line-73"></a> <span class='hs-layout'>(</span><span class='hs-varid'>const</span> <span class='hs-varop'>$</span> <span class='hs-varid'>tbody</span> <span class='hs-varid'>conn</span><span class='hs-layout'>)</span>
<a name="line-74"></a>
<a name="line-75"></a><a name="withConnectionIO"></a><span class='hs-comment'>-- | Run a transaction on a HDBC 'IConnection' and close the connection.</span>
<a name="line-76"></a><span class='hs-comment'>-- Simple 'IO' version.</span>
<a name="line-77"></a><span class='hs-definition'>withConnectionIO</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IConnection</span> <span class='hs-varid'>conn</span>
<a name="line-78"></a> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>conn</span> <span class='hs-comment'>-- ^ Connect action</span>
<a name="line-79"></a> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>conn</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-comment'>-- ^ Transaction body</span>
<a name="line-80"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span> <span class='hs-comment'>-- ^ Result transaction action</span>
<a name="line-81"></a><span class='hs-definition'>withConnectionIO</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>withConnection</span> <span class='hs-varid'>bracket</span> <span class='hs-varid'>id</span>
<a name="line-82"></a>
<a name="line-83"></a><a name="withConnectionCommit"></a><span class='hs-comment'>-- | Same as 'withConnectionIO' other than issuing commit at the end of transaction body.</span>
<a name="line-84"></a><span class='hs-comment'>-- In other words, the transaction with no exception is committed.</span>
<a name="line-85"></a><span class='hs-comment'>-- Handy defintion for simple transactions.</span>
<a name="line-86"></a><span class='hs-definition'>withConnectionCommit</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IConnection</span> <span class='hs-varid'>conn</span>
<a name="line-87"></a> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>conn</span> <span class='hs-comment'>-- ^ Connect action</span>
<a name="line-88"></a> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>conn</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-comment'>-- ^ Transaction body</span>
<a name="line-89"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span> <span class='hs-comment'>-- ^ Result transaction action</span>
<a name="line-90"></a><span class='hs-definition'>withConnectionCommit</span> <span class='hs-varid'>conn</span> <span class='hs-varid'>body</span> <span class='hs-keyglyph'>=</span>
<a name="line-91"></a> <span class='hs-varid'>withConnectionIO</span> <span class='hs-varid'>conn</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-92"></a> <span class='hs-varid'>x</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>body</span> <span class='hs-varid'>c</span>
<a name="line-93"></a> <span class='hs-conid'>HDBC</span><span class='hs-varop'>.</span><span class='hs-varid'>commit</span> <span class='hs-varid'>c</span>
<a name="line-94"></a> <span class='hs-varid'>return</span> <span class='hs-varid'>x</span>
<a name="line-95"></a>
<a name="line-96"></a><a name="withConnectionIO'"></a><span class='hs-comment'>-- | Same as 'withConnectionIO' other than wrapping transaction body in 'handleSqlError''.</span>
<a name="line-97"></a><span class='hs-definition'>withConnectionIO'</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IConnection</span> <span class='hs-varid'>conn</span>
<a name="line-98"></a> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>conn</span> <span class='hs-comment'>-- ^ Connect action</span>
<a name="line-99"></a> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>conn</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-comment'>-- ^ Transaction body</span>
<a name="line-100"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span> <span class='hs-comment'>-- ^ Result transaction action</span>
<a name="line-101"></a><span class='hs-definition'>withConnectionIO'</span> <span class='hs-varid'>connect</span> <span class='hs-varid'>body</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>withConnectionIO</span> <span class='hs-varid'>connect</span> <span class='hs-varop'>$</span> <span class='hs-varid'>handleSqlError'</span> <span class='hs-varop'>.</span> <span class='hs-varid'>body</span>
</pre></body>
</html>
|