X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fref-oodml.xml;h=51cb36c80737a81d38c272f1379f1a689249593a;hb=2949884623a44f1866a383fb74a88aada9fced93;hp=094db326e23ce83d2140144294fd81326f03b30f;hpb=d0695ffb828519fade3aa5166236812e6144975b;p=clsql.git

diff --git a/doc/ref-oodml.xml b/doc/ref-oodml.xml
index 094db32..51cb36c 100644
--- 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
+	<varname>CACHING</varname> 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>