2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4 <!ENTITY % myents SYSTEM "entities.inc">
8 <!-- Transaction handling -->
9 <reference id="ref-transaction">
10 <title>Transaction Handling</title>
17 <refentry id="add-transaction-commit-hook">
19 <refname>ADD-TRANSACTION-COMMIT-HOOK</refname>
20 <refpurpose><!-- purpose --></refpurpose>
21 <refclass>Function</refclass>
26 <function> (ADD-TRANSACTION-COMMIT-HOOK DATABASE COMMIT-HOOK) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
29 <title>Arguments and Values</title>
31 <!-- arguments and values -->
35 <title>Description</title>
41 <title>Examples</title>
47 <title>Side Effects</title>
53 <title>Affected by</title>
61 <title>Exceptional Situations</title>
63 <!-- execeptional situations -->
67 <title>See Also</title>
70 <!-- see also list here -->
82 <refentry id="add-transaction-rollback-hook">
84 <refname>ADD-TRANSACTION-ROLLBACK-HOOK</refname>
85 <refpurpose><!-- purpose --></refpurpose>
86 <refclass>Function</refclass>
91 <function> (ADD-TRANSACTION-ROLLBACK-HOOK DATABASE ROLLBACK-HOOK) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
94 <title>Arguments and Values</title>
96 <!-- arguments and values -->
100 <title>Description</title>
106 <title>Examples</title>
112 <title>Side Effects</title>
114 <!-- side effects -->
118 <title>Affected by</title>
126 <title>Exceptional Situations</title>
128 <!-- execeptional situations -->
132 <title>See Also</title>
135 <!-- see also list here -->
147 <refentry id="commit">
149 <refname>COMMIT</refname>
150 <refpurpose><!-- purpose --></refpurpose>
151 <refclass>Function</refclass>
154 <title>Syntax</title>
156 <function> (COMMIT &KEY (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
159 <title>Arguments and Values</title>
161 <!-- arguments and values -->
165 <title>Description</title>
166 <para>If DATABASE, which defaults to *DEFAULT-DATABASE*, is
167 currently within the scope of a transaction, commits changes
168 made since the transaction began.
172 <title>Examples</title>
178 <title>Side Effects</title>
180 <!-- side effects -->
184 <title>Affected by</title>
192 <title>Exceptional Situations</title>
194 <!-- execeptional situations -->
198 <title>See Also</title>
214 <refentry id="in-transaction-p">
216 <refname>IN-TRANSACTION-P</refname>
217 <refpurpose><!-- purpose --></refpurpose>
218 <refclass>Function</refclass>
221 <title>Syntax</title>
223 <function> (IN-TRANSACTION-P &KEY (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
226 <title>Arguments and Values</title>
228 <!-- arguments and values -->
232 <title>Description</title>
233 <para>A predicate to test whether DATABASE, which
234 defaults to *DEFAULT-DATABASE*, is currently within
235 the scope of a transaction.
239 <title>Examples</title>
245 <title>Side Effects</title>
247 <!-- side effects -->
251 <title>Affected by</title>
259 <title>Exceptional Situations</title>
261 <!-- execeptional situations -->
265 <title>See Also</title>
280 <refentry id="rollback">
282 <refname>ROLLBACK</refname>
283 <refpurpose><!-- purpose --></refpurpose>
284 <refclass>Function</refclass>
287 <title>Syntax</title>
289 <function> (ROLLBACK &KEY (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
292 <title>Arguments and Values</title>
294 <!-- arguments and values -->
298 <title>Description</title>
299 <para>If DATABASE, which defaults to *DEFAULT-DATABASE*, is
300 currently within the scope of a transaction, rolls back changes
301 made since the transaction began.
305 <title>Examples</title>
311 <title>Side Effects</title>
313 <!-- side effects -->
317 <title>Affected by</title>
325 <title>Exceptional Situations</title>
327 <!-- execeptional situations -->
331 <title>See Also</title>
346 <refentry id="set-autocommit">
348 <refname>SET-AUTOCOMMIT</refname>
349 <refpurpose><!-- purpose --></refpurpose>
350 <refclass>Function</refclass>
353 <title>Syntax</title>
355 <function> (SET-AUTOCOMMIT VALUE &KEY (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
358 <title>Arguments and Values</title>
360 <!-- arguments and values -->
364 <title>Description</title>
365 <para>Sets autocommit on or off. Returns old value of of autocommit flag.
369 <title>Examples</title>
375 <title>Side Effects</title>
377 <!-- side effects -->
381 <title>Affected by</title>
389 <title>Exceptional Situations</title>
391 <!-- execeptional situations -->
395 <title>See Also</title>
413 <refentry id="start-transaction">
415 <refname>START-TRANSACTION</refname>
416 <refpurpose><!-- purpose --></refpurpose>
417 <refclass>Function</refclass>
420 <title>Syntax</title>
422 <function> (START-TRANSACTION &KEY (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
425 <title>Arguments and Values</title>
427 <!-- arguments and values -->
431 <title>Description</title>
432 <para>Starts a transaction block on DATABASE which defaults to
433 *DEFAULT-DATABASE* and which continues until ROLLBACK or COMMIT
438 <title>Examples</title>
444 <title>Side Effects</title>
446 <!-- side effects -->
450 <title>Affected by</title>
458 <title>Exceptional Situations</title>
460 <!-- execeptional situations -->
464 <title>See Also</title>
479 <refentry id="with-transaction">
481 <refname>WITH-TRANSACTION</refname>
482 <refpurpose><!-- purpose --></refpurpose>
483 <refclass>Function</refclass>
486 <title>Syntax</title>
488 <function> (WITH-TRANSACTION &KEY (DATABASE '*DEFAULT-DATABASE*) &REST BODY) [macro]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
491 <title>Arguments and Values</title>
493 <!-- arguments and values -->
497 <title>Description</title>
498 <para>Starts a transaction in the database
499 specified by DATABASE, which is *DEFAULT-DATABASE* by
500 default, and executes BODY within that transaction. If
501 BODY aborts or throws, DATABASE is rolled back and
502 otherwise the transaction is committed.
506 <title>Examples</title>
512 <title>Side Effects</title>
514 <!-- side effects -->
518 <title>Affected by</title>
526 <title>Exceptional Situations</title>
528 <!-- execeptional situations -->
532 <title>See Also</title>