libocamlodbc-ocaml-dev 2.15-6build1 / usr / share / doc / libocamlodbc-ocaml-dev / html / Ocamlodbc.html

This file is indexed.

/usr/share/doc/libocamlodbc-ocaml-dev/html/Ocamlodbc.html is in libocamlodbc-ocaml-dev 2.15-6build1.

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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Ocamlodbc" rel="Chapter" href="Ocamlodbc.html"><link title="Classic interface" rel="Section" href="#2_Classicinterface">
<link title="Object-oriented interface" rel="Section" href="#2_Objectorientedinterface">
<title>Ocamlodbc</title>
</head>
<body>
<div class="navbar">&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;</div>
<h1>Module <a href="type_Ocamlodbc.html">Ocamlodbc</a></h1>

<pre><span class="keyword">module</span> Ocamlodbc: <code class="code">sig</code> <a href="Ocamlodbc.html">..</a> <code class="code">end</code></pre><div class="info module top">
Interface to ODBC databases.
<p>

    See http://home.gna.org/ocamlodbc/configuring.html for
    configutation information.<br>
</div>
<hr width="100%">

<pre><span id="VALversion"><span class="keyword">val</span> version</span> : <code class="type">string</code></pre><div class="info ">
Version of the library.<br>
</div>

<pre><span id="EXCEPTIONSQL_Error"><span class="keyword">exception</span> SQL_Error</span> <span class="keyword">of</span> <code class="type">string</code></pre>
<div class="info ">
To report errors.<br>
</div>

<pre><code><span id="TYPEsql_column_type"><span class="keyword">type</span> <code class="type"></code>sql_column_type</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_unknown"><span class="constructor">SQL_unknown</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_char"><span class="constructor">SQL_char</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_numeric"><span class="constructor">SQL_numeric</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_decimal"><span class="constructor">SQL_decimal</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_integer"><span class="constructor">SQL_integer</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_smallint"><span class="constructor">SQL_smallint</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_float"><span class="constructor">SQL_float</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_real"><span class="constructor">SQL_real</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_double"><span class="constructor">SQL_double</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_varchar"><span class="constructor">SQL_varchar</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_date"><span class="constructor">SQL_date</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_time"><span class="constructor">SQL_time</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_timestamp"><span class="constructor">SQL_timestamp</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_longvarchar"><span class="constructor">SQL_longvarchar</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_binary"><span class="constructor">SQL_binary</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_varbinary"><span class="constructor">SQL_varbinary</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_longvarbinary"><span class="constructor">SQL_longvarbinary</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_bigint"><span class="constructor">SQL_bigint</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_tinyint"><span class="constructor">SQL_tinyint</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTsql_column_type.SQL_bit"><span class="constructor">SQL_bit</span></span></code></td>

</tr></table>

<div class="info ">
The various SQL types for columns.<br>
</div>


<pre><span class="keyword">module</span> <a href="Ocamlodbc.SQL_column.html">SQL_column</a>: <code class="code">sig</code> <a href="Ocamlodbc.SQL_column.html">..</a> <code class="code">end</code></pre><br>
<h2 id="2_Classicinterface">Classic interface</h2><br>

<pre><span id="TYPEconnection"><span class="keyword">type</span> <code class="type"></code>connection</span> </pre>
<div class="info ">
The type of connections to databases.<br>
</div>


<pre><span id="VALconnect"><span class="keyword">val</span> connect</span> : <code class="type">string -> string -> string -> <a href="Ocamlodbc.html#TYPEconnection">connection</a></code></pre><div class="info ">
<code class="code">connect base user passwd</code> creates a connection to data source
      <code class="code">base</code>, as user <code class="code">user</code>, with password <code class="code">passwd</code>.<br>
<b>Raises</b> <code>SQL_Error</code> if the connection to the database failed.<br>
</div>

<pre><span id="VALconnect_driver"><span class="keyword">val</span> connect_driver</span> : <code class="type">?prompt:bool -> string -> <a href="Ocamlodbc.html#TYPEconnection">connection</a></code></pre><div class="info ">
<code class="code">connect_driver conn_string</code> exposes the SQLDriverConnect
      function to OCaml (for ODBC v2 or greater under MinGW).  This
      allows SQLServer "trusted authentication" mode based on NT
      domain identities.  An example of <code class="code">conn_string</code> is <code class="code">"Driver={SQL
      Server};SERVER=FOOSERVER;Trusted_Connection=yes;Database=MYDB"</code>.<br>
<b>Raises</b> <code>SQL_Error</code> if the connection to the database failed.<br>
</div>
<div class="param_info"><code class="code">prompt</code> : tells whether the if the driver should raise a
      dialog box to request username and password.  Default: <code class="code">false</code>.</div>

<pre><span id="VALdisconnect"><span class="keyword">val</span> disconnect</span> : <code class="type"><a href="Ocamlodbc.html#TYPEconnection">connection</a> -> unit</code></pre><div class="info ">
Disconnect from a database. The given connection should not be
      used after this function was called.<br>
<b>Raises</b> <code>SQL_Error</code> if an error occured while disconnecting.<br>
</div>

<pre><span id="VALexecute"><span class="keyword">val</span> execute</span> : <code class="type"><a href="Ocamlodbc.html#TYPEconnection">connection</a> -> string -> int * string option list list</code></pre><div class="info ">
<code class="code">execute c q</code> executes query <code class="code">q</code> through connection <code class="code">c</code> and
      returns the result as a pair <code class="code">(error_code, recordlist)</code>, where a
      record is a <code class="code">string option list</code>.  The <code class="code">error_code</code> is 0 if no
      error occured.  Each field of a record can be <code class="code">None</code>, which
      represents the SQL NULL, or <code class="code">Some v</code> where <code class="code">v</code> is a string holding
      the field value.<br>
</div>

<pre><span id="VALexecute_with_info"><span class="keyword">val</span> execute_with_info</span> : <code class="type"><a href="Ocamlodbc.html#TYPEconnection">connection</a> -><br>       string -><br>       int * (string * <a href="Ocamlodbc.html#TYPEsql_column_type">sql_column_type</a>) list * string option list list</code></pre><div class="info ">
<code class="code">execute_with_info c q</code> executes query <code class="code">q</code> through connection <code class="code">c</code> and
      returns the result as a tuple <code class="code">(error_code, type_list, record list)</code>,
      where <code class="code">type_list</code> indicates the SQL types of the returned columns,
      and a record is a <code class="code">string list</code>.
      The <code class="code">error_code</code> is <code class="code">&gt;= 0</code> if no error occured.<br>
</div>

<pre><span id="VALexecute_gen"><span class="keyword">val</span> execute_gen</span> : <code class="type"><a href="Ocamlodbc.html#TYPEconnection">connection</a> -><br>       ?get_info:bool -><br>       ?n_rec:int -><br>       string -><br>       (string option list list -> unit) -><br>       int * (string * <a href="Ocamlodbc.html#TYPEsql_column_type">sql_column_type</a>) list</code></pre><div class="info ">
<code class="code">execute_gen c get_info n_rec q callback</code> executes query <code class="code">q</code> over
      the connection <code class="code">c</code>, and invokes <code class="code">callback</code> on successful blocks of
      the results (of <code class="code">n_rec</code> records each). Each record is a <code class="code">string
      list</code> of fields.
<p>

      The result is a tuple <code class="code">(error_code, type_list)</code>.  The
      <code class="code">error_code</code> is <code class="code">&gt;= 0</code> if no error occurred, <code class="code">type_list</code> is
      empty if <code class="code">get_info</code> is <code class="code">false</code>.<br>
</div>
<br>
<h2 id="2_Objectorientedinterface">Object-oriented interface</h2><br>

<pre><span name="TYPEdata_base"><span class="keyword">class</span> <a href="Ocamlodbc.data_base-c.html">data_base</a></span> : <code class="type">string -> string -> string -> </code><code class="code">object</code> <a href="Ocamlodbc.data_base-c.html">..</a> <code class="code">end</code></pre><div class="info">
The class which represents a connection to a database.
</div>
</body></html>

APT Browse - Built by Thomas Orozco.