r10040: 28 Sep 2004 Kevin Rosenberg <kevin@rosenberg.net>

[clsql.git] / doc / ref-oodml.xml

diff --git a/doc/ref-oodml.xml b/doc/ref-oodml.xml
index 094db326e23ce83d2140144294fd81326f03b30f..a76b718b3bbf5a87ce7531d97620e063984b5ba2 100644 (file)
--- a/doc/ref-oodml.xml
+++ b/doc/ref-oodml.xml
@@ -124,6 +124,57 @@
     </refsect1>
   </refentry>
 
+  <refentry id="default-caching">
+    <refnamediv>
+      <refname>*DEFAULT-CACHING*</refname>
+      <refpurpose>Controls the default caching behavior.</refpurpose>
+      <refclass>Variable</refclass>
+    </refnamediv>
+    <refsect1>
+      <title>Value Type</title>
+      <para>
+       Boolean
+      </para> 
+    </refsect1>
+    <refsect1>
+      <title>Initial Value</title>
+      <para>&t;</para>
+    </refsect1>
+    <refsect1>
+      <title>Description</title> 
+      <para>
+       This variable stores the default value of the
+       <variable>CACHING</variable> keyword for the <link
+       linkend="select"><function>select</function></link>.
+      </para> 
+    </refsect1>
+    <refsect1>
+      <title>Examples</title>
+      <screen>
+       (let ((*default-caching* nil)))
+         (select 'foo))
+
+       ;; is equivalent to
+
+       (select 'foo :caching nil)
+      </screen>
+    </refsect1>
+    <refsect1>
+      <title>Affected By</title>
+      <para>None.</para>
+    </refsect1>
+    <refsect1>
+      <title>See Also</title>
+      <simplelist>
+        <member><link linkend="select"><function>select</function></link></member>
+      </simplelist>
+    </refsect1>
+    <refsect1>
+      <title>Notes</title> <para>This is a CLSQL extension to the
+      &commonsql; API. &commonsql; has caching on at all times.</para>
+    </refsect1>
+  </refentry>
+
   <refentry id="default-update-objects-max-len">
     <refnamediv>
       <refname>*DEFAULT-UPDATE-OBJECTS-MAX-LEN*</refname>