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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
|
<html>
<head>
<title>sql API reference (clojure-contrib)</title>
<link href="static/favicon.png" rel="icon" />
<link href="static/favicon.png" rel="shortcut icon" />
<link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
<link media="all" type="text/css" href="static/wiki.css" rel="stylesheet" />
<link media="all" type="text/css" href="static/internal.css" rel="stylesheet" />
<!-- TODO: are we using these (from clojure.org)? If so, add the files -->
<script src="file/view/code_highlighter.js" type="text/javascript"></script>
<script src="file/view/clojure.js" type="text/javascript"></script>
<style>.menuWrapper{height: 36px;}</style>
<!--[if lte IE 6]>
<link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
<![endif]-->
</head>
<!--
This document was auto-generated from the source by the clojure autodoc system.
To report errors or ask questions about the overall documentation structure, formatting,
etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
For errors in the documentation of a particular namespace, contact the author of that
namespace.
-->
<body>
<div id="AllContentContainer">
<div id="Header">
<a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="static/clojure-icon.gif" /></a>
<h1><a title="page header title" id="page-header" href="index.html">Clojure-contrib API Reference</a></h1>
</div>
<div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
<div class="WikiCustomNav WikiElement wiki">
<div class="BranchTOC">
<a class="wiki_link" href="#">Branches</a>
<ul id="left-sidebar-branch-list">
<li><a href="index.html" class="wiki_link">master</a></li><li><a href="branch-1.1.x/index.html" class="wiki_link">1.1.x</a></li>
</ul>
</div>
<a class="wiki_link" href="index.html">Overview</a><br />
<a class="wiki_link" href="api-index.html">API Index</a><br />
<a class="wiki_link" href="#">Namespaces:</a>
<ul id="left-sidebar-list">
<li><a href="accumulators-api.html" class="wiki_link">accumulators</a></li><li><a href="agent-utils-api.html" class="wiki_link">agent-utils</a></li><li><a href="apply-macro-api.html" class="wiki_link">apply-macro</a></li><li><a href="base64-api.html" class="wiki_link">base64</a></li><li><a href="classpath-api.html" class="wiki_link">classpath</a></li><li><a href="combinatorics-api.html" class="wiki_link">combinatorics</a></li><li><a href="command-line-api.html" class="wiki_link">command-line</a></li><li><a href="complex-numbers-api.html" class="wiki_link">complex-numbers</a></li><li><a href="cond-api.html" class="wiki_link">cond</a></li><li><a href="condition-api.html" class="wiki_link">condition</a></li><li><a href="core-api.html" class="wiki_link">core</a></li><li><a href="dataflow-api.html" class="wiki_link">dataflow</a></li><li><a href="datalog-api.html" class="wiki_link">datalog</a></li><li><a href="def-api.html" class="wiki_link">def</a></li><li><a href="error-kit-api.html" class="wiki_link">error-kit</a></li><li><a href="except-api.html" class="wiki_link">except</a></li><li><a href="fcase-api.html" class="wiki_link">fcase</a></li><li><a href="find-namespaces-api.html" class="wiki_link">find-namespaces</a></li><li><a href="fnmap-api.html" class="wiki_link">fnmap</a></li><li><a href="gen-html-docs-api.html" class="wiki_link">gen-html-docs</a></li><li><a href="generic.arithmetic-api.html" class="wiki_link">generic.arithmetic</a></li><li><a href="generic.collection-api.html" class="wiki_link">generic.collection</a></li><li><a href="generic.comparison-api.html" class="wiki_link">generic.comparison</a></li><li><a href="generic.functor-api.html" class="wiki_link">generic.functor</a></li><li><a href="generic.math-functions-api.html" class="wiki_link">generic.math-functions</a></li><li><a href="graph-api.html" class="wiki_link">graph</a></li><li><a href="greatest-least-api.html" class="wiki_link">greatest-least</a></li><li><a href="http.agent-api.html" class="wiki_link">http.agent</a></li><li><a href="http.connection-api.html" class="wiki_link">http.connection</a></li><li><a href="import-static-api.html" class="wiki_link">import-static</a></li><li><a href="io-api.html" class="wiki_link">io</a></li><li><a href="jar-api.html" class="wiki_link">jar</a></li><li><a href="javadoc.browse-api.html" class="wiki_link">javadoc.browse</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json-api.html" class="wiki_link">json</a></li><li><a href="lazy-seqs-api.html" class="wiki_link">lazy-seqs</a></li><li><a href="lazy-xml-api.html" class="wiki_link">lazy-xml</a></li><li><a href="logging-api.html" class="wiki_link">logging</a></li><li><a href="macro-utils-api.html" class="wiki_link">macro-utils</a></li><li><a href="macros-api.html" class="wiki_link">macros</a></li><li><a href="map-utils-api.html" class="wiki_link">map-utils</a></li><li><a href="math-api.html" class="wiki_link">math</a></li><li><a href="miglayout-api.html" class="wiki_link">miglayout</a></li><li><a href="mmap-api.html" class="wiki_link">mmap</a></li><li><a href="mock-api.html" class="wiki_link">mock</a></li><li><a href="monadic-io-streams-api.html" class="wiki_link">monadic-io-streams</a></li><li><a href="monads-api.html" class="wiki_link">monads</a></li><li><a href="ns-utils-api.html" class="wiki_link">ns-utils</a></li><li><a href="pprint-api.html" class="wiki_link">pprint</a></li><li><a href="probabilities.finite-distributions-api.html" class="wiki_link">probabilities.finite-distributions</a></li><li><a href="probabilities.monte-carlo-api.html" class="wiki_link">probabilities.monte-carlo</a></li><li><a href="probabilities.random-numbers-api.html" class="wiki_link">probabilities.random-numbers</a></li><li><a href="profile-api.html" class="wiki_link">profile</a></li><li><a href="properties-api.html" class="wiki_link">properties</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="reflect-api.html" class="wiki_link">reflect</a></li><li><a href="repl-ln-api.html" class="wiki_link">repl-ln</a></li><li><a href="repl-utils-api.html" class="wiki_link">repl-utils</a></li><li><a href="seq-api.html" class="wiki_link">seq</a></li><li><a href="server-socket-api.html" class="wiki_link">server-socket</a></li><li><a href="set-api.html" class="wiki_link">set</a></li><li><a href="shell-api.html" class="wiki_link">shell</a></li><li><a href="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="string-api.html" class="wiki_link">string</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-is-api.html" class="wiki_link">test-is</a></li><li><a href="trace-api.html" class="wiki_link">trace</a></li><li><a href="types-api.html" class="wiki_link">types</a></li><li><a href="with-ns-api.html" class="wiki_link">with-ns</a></li><li><a href="zip-filter-api.html" class="wiki_link">zip-filter</a></li>
</ul>
</div>
</div>
</div>
<div id="rightcolumn">
<div id="Content">
<div class="contentBox"><div class="innerContentBox">
<div id="content_view" class="wiki wikiPage">
<div id="right-sidebar"><div id="toc">
<h1 class="nopad">Table of Contents</h1>
<div style="margin-left: 1em;" class="toc-section">
<a href="#toc0">Overview</a>
<div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql/connection">connection</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql/create-table">create-table</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql/delete-rows">delete-rows</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql/do-commands">do-commands</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql/do-prepared">do-prepared</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql/drop-table">drop-table</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql/find-connection">find-connection</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql/insert-records">insert-records</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql/insert-rows">insert-rows</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql/insert-values">insert-values</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql/is-rollback-only">is-rollback-only</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql/set-rollback-only">set-rollback-only</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql/transaction">transaction</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql/update-or-insert-values">update-or-insert-values</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql/update-values">update-values</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql/with-connection">with-connection</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql/with-query-results">with-query-results</a>
</div>
<br />
</div><div style="margin-left: 1em;" class="toc-section">
<a href="#sql.internal">sql.internal</a>
<div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql.internal/connection*">connection*</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql.internal/find-connection*">find-connection*</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql.internal/get-connection">get-connection</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql.internal/print-sql-exception">print-sql-exception</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql.internal/print-sql-exception-chain">print-sql-exception-chain</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql.internal/print-update-counts">print-update-counts</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql.internal/rollback">rollback</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql.internal/throw-rollback">throw-rollback</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql.internal/transaction*">transaction*</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql.internal/with-connection*">with-connection*</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.sql.internal/with-query-results*">with-query-results*</a>
</div>
<br />
</div>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="namespace-name">sql</span>
<span id="branch-name">(master branch)</span></h1>
by <span id="author">Stephen C. Gilardi</span><br />
<br />Usage:
<pre>
(ns your-namespace
(:require <span id="long-name">clojure.contrib.sql</span>))
</pre><pre>
</pre><h2>Overview</h2>
<pre id="namespace-docstr">A Clojure interface to sql databases via jdbc
See clojure.contrib.sql.test for an example</pre>
<span id="see-also">See also:
<span id="see-also-link">
<a href="http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/sql/test.clj">Example code</a>
</span><br />
</span><br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.sql/connection">connection</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (connection)
</pre>
<pre id="var-docstr">Returns the current database connection (or throws if there is none)</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql.clj#L32" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.sql/create-table">create-table</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (create-table name & specs)
</pre>
<pre id="var-docstr">Creates a table on the open database connection given a table name and
specs. Each spec is either a column spec: a vector containing a column
name and optionally a type and other constraints, or a table-level
constraint: a vector containing words that express the constraint. All
words used to describe the table may be supplied as strings or keywords.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql.clj#L105" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.sql/delete-rows">delete-rows</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (delete-rows table where-params)
</pre>
<pre id="var-docstr">Deletes rows from a table. where-params is a vector containing a string
providing the (optionally parameterized) selection criteria followed by
values for any parameters.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql.clj#L159" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.sql/do-commands">do-commands</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (do-commands & commands)
</pre>
<pre id="var-docstr">Executes SQL commands on the open database connection.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql.clj#L83" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.sql/do-prepared">do-prepared</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (do-prepared sql & param-groups)
</pre>
<pre id="var-docstr">Executes an (optionally parameterized) SQL prepared statement on the
open database connection. Each param-group is a seq of values for all of
the parameters.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql.clj#L92" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.sql/drop-table">drop-table</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (drop-table name)
</pre>
<pre id="var-docstr">Drops a table on the open database connection given its name, a string
or keyword</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql.clj#L121" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.sql/find-connection">find-connection</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (find-connection)
</pre>
<pre id="var-docstr">Returns the current database connection (or nil if there is none)</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql.clj#L31" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.sql/insert-records">insert-records</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (insert-records table & records)
</pre>
<pre id="var-docstr">Inserts records into a table. records are maps from strings or
keywords (identifying columns) to values.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql.clj#L152" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.sql/insert-rows">insert-rows</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (insert-rows table & rows)
</pre>
<pre id="var-docstr">Inserts complete rows into a table. Each row is a vector of values for
each of the table's columns in order.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql.clj#L146" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.sql/insert-values">insert-values</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (insert-values table column-names & value-groups)
</pre>
<pre id="var-docstr">Inserts rows into a table with values for specified columns only.
column-names is a vector of strings or keywords identifying columns. Each
value-group is a vector containing a values for each column in
order. When inserting complete rows (all columns), consider using
insert-rows instead.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql.clj#L128" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.sql/is-rollback-only">is-rollback-only</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (is-rollback-only)
</pre>
<pre id="var-docstr">Returns true if the outermost transaction will rollback rather than
commit when complete</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql.clj#L77" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.sql/set-rollback-only">set-rollback-only</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (set-rollback-only)
</pre>
<pre id="var-docstr">Marks the outermost transaction such that it will rollback rather than
commit when complete</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql.clj#L71" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.sql/transaction">transaction</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (transaction & body)
</pre>
<pre id="var-docstr">Evaluates body as a transaction on the open database connection. Any
nested transactions are absorbed into the outermost transaction. By
default, all database updates are committed together as a group after
evaluating the outermost body, or rolled back on any uncaught
exception. If set-rollback-only is called within scope of the outermost
transaction, the entire transaction will be rolled back rather than
committed when complete.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql.clj#L60" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.sql/update-or-insert-values">update-or-insert-values</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (update-or-insert-values table where-params record)
</pre>
<pre id="var-docstr">Updates values on selected rows in a table, or inserts a new row when no
existing row matches the selection criteria. where-params is a vector
containing a string providing the (optionally parameterized) selection
criteria followed by values for any parameters. record is a map from
strings or keywords (identifying columns) to updated values.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql.clj#L184" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.sql/update-values">update-values</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (update-values table where-params record)
</pre>
<pre id="var-docstr">Updates values on selected rows in a table. where-params is a vector
containing a string providing the (optionally parameterized) selection
criteria followed by values for any parameters. record is a map from
strings or keywords (identifying columns) to updated values.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql.clj#L170" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.sql/with-connection">with-connection</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (with-connection db-spec & body)
</pre>
<pre id="var-docstr">Evaluates body in the context of a new connection to a database then
closes the connection. db-spec is a map containing values for one of the
following parameter sets:
Factory:
:factory (required) a function of one argument, a map of params
(others) (optional) passed to the factory function in a map
DriverManager:
:classname (required) a String, the jdbc driver class name
:subprotocol (required) a String, the jdbc subprotocol
:subname (required) a String, the jdbc subname
(others) (optional) passed to the driver as properties.
DataSource:
:datasource (required) a javax.sql.DataSource
:username (optional) a String
:password (optional) a String, required if :username is supplied
JNDI:
:name (required) a String or javax.naming.Name
:environment (optional) a java.util.Map</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql.clj#L34" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.sql/with-query-results">with-query-results</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (with-query-results results sql-params & body)
</pre>
<pre id="var-docstr">Executes a query, then evaluates body with results bound to a seq of the
results. sql-params is a vector containing a string providing
the (optionally parameterized) SQL query followed by values for any
parameters.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql.clj#L197" id="var-source">Source</a>
</div>
<h2 id="namespace-name">sql.internal</h2>
<pre id="namespace-docstr"></pre>
<br />
<div id="var-entry">
<hr />
<h2 id="clojure.contrib.sql.internal/connection*">connection*</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (connection*)
</pre>
<pre id="var-docstr">Returns the current database connection (or throws if there is none)</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql/internal.clj#L38" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="clojure.contrib.sql.internal/find-connection*">find-connection*</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (find-connection*)
</pre>
<pre id="var-docstr">Returns the current database connection (or nil if there is none)</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql/internal.clj#L33" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="clojure.contrib.sql.internal/get-connection">get-connection</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (get-connection {:keys [factory classname subprotocol subname datasource username password name environment], :as db-spec})
</pre>
<pre id="var-docstr">Creates a connection to a database. db-spec is a map containing values
for one of the following parameter sets:
Factory:
:factory (required) a function of one argument, a map of params
(others) (optional) passed to the factory function in a map
DriverManager:
:classname (required) a String, the jdbc driver class name
:subprotocol (required) a String, the jdbc subprotocol
:subname (required) a String, the jdbc subname
(others) (optional) passed to the driver as properties.
DataSource:
:datasource (required) a javax.sql.DataSource
:username (optional) a String
:password (optional) a String, required if :username is supplied
JNDI:
:name (required) a String or javax.naming.Name
:environment (optional) a java.util.Map</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql/internal.clj#L51" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="clojure.contrib.sql.internal/print-sql-exception">print-sql-exception</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (print-sql-exception stream exception)
</pre>
<pre id="var-docstr">Prints the contents of an SQLException to stream</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql/internal.clj#L107" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="clojure.contrib.sql.internal/print-sql-exception-chain">print-sql-exception-chain</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (print-sql-exception-chain stream exception)
</pre>
<pre id="var-docstr">Prints a chain of SQLExceptions to stream</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql/internal.clj#L121" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="clojure.contrib.sql.internal/print-update-counts">print-update-counts</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (print-update-counts stream exception)
</pre>
<pre id="var-docstr">Prints the update counts from a BatchUpdateException to stream</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql/internal.clj#L129" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="clojure.contrib.sql.internal/rollback">rollback</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (rollback)
(rollback val)
</pre>
<pre id="var-docstr">Accessor for the rollback flag on the current connection</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql/internal.clj#L44" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="clojure.contrib.sql.internal/throw-rollback">throw-rollback</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (throw-rollback e)
</pre>
<pre id="var-docstr">Sets rollback and throws a wrapped exception</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql/internal.clj#L138" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="clojure.contrib.sql.internal/transaction*">transaction*</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (transaction* func)
</pre>
<pre id="var-docstr">Evaluates func as a transaction on the open database connection. Any
nested transactions are absorbed into the outermost transaction. By
default, all database updates are committed together as a group after
evaluating the outermost body, or rolled back on any uncaught
exception. If rollback is set within scope of the outermost transaction,
the entire transaction will be rolled back rather than committed when
complete.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql/internal.clj#L144" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="clojure.contrib.sql.internal/with-connection*">with-connection*</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (with-connection* db-spec func)
</pre>
<pre id="var-docstr">Evaluates func in the context of a new connection to a database then
closes the connection.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql/internal.clj#L98" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="clojure.contrib.sql.internal/with-query-results*">with-query-results*</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (with-query-results* [sql & params :as sql-params] func)
</pre>
<pre id="var-docstr">Executes a query, then evaluates func passing in a seq of the results as
an argument. The first argument is a vector containing the (optionally
parameterized) sql query string followed by values for any parameters.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/6a0483d9e216ca00fc648a4b3673996b76a2785a/src/main/clojure/clojure/contrib/sql/internal.clj#L178" id="var-source">Source</a>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="foot">
<div style="text-align: center;" id="copyright">Copyright 2007-2009 by Rich Hickey and the various contributors</div>
</div>
</div>
<div id="DesignedBy">Logo & site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br />
Clojure auto-documentation system by Tom Faulhaber.</div>
</div>
<!-- /AllContentContainer -->
</body>
</html>
|
