doc/ref-lob.xml

   1 <?xml version='1.0' ?>
   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">
   5 %myents;
   6 ]>
   7
   8 <reference id="ref-lob">
   9   <title>Large Object Support</title>
  10   <partintro>
  11     <para>
  12       <!-- introduction -->
  13     </para>
  14   </partintro>
  15
  16   <refentry id="create-large-object">
  17     <refnamediv>
  18       <refname>CREATE-LARGE-OBJECT</refname>
  19       <refpurpose><!-- purpose --></refpurpose>
  20       <refclass>Function</refclass>
  21     </refnamediv>
  22     <refsect1>
  23       <title>Syntax</title>
  24       <synopsis>
  25       <function> (CREATE-LARGE-OBJECT &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
  26     </refsect1>
  27     <refsect1>
  28       <title>Arguments and Values</title>
  29       <variablelist>
  30         <!-- arguments and values -->
  31       </variablelist>
  32     </refsect1>
  33     <refsect1>
  34       <title>Description</title>
  35       <para>Creates a new large object in the database and returns
  36       the object identifier
  37       </para>
  38     </refsect1>
  39     <refsect1>
  40       <title>Examples</title>
  41       <screen>
  42         <!-- examples -->
  43       </screen>
  44     </refsect1>
  45     <refsect1>
  46       <title>Side Effects</title>
  47       <para>
  48         <!-- side effects -->
  49       </para>
  50     </refsect1>
  51     <refsect1>
  52       <title>Affected by</title>
  53       <para>
  54         <simplelist>
  55           <!-- affected by -->
  56         </simplelist>
  57       </para>
  58     </refsect1>
  59     <refsect1>
  60       <title>Exceptional Situations</title>
  61       <para>
  62         <!-- execeptional situations -->
  63       </para>
  64     </refsect1>
  65     <refsect1>
  66       <title>See Also</title>
  67       <para>
  68         <simplelist>
  69           <!-- see also -->
  70         </simplelist>
  71       </para>
  72     </refsect1>
  73     <refsect1>
  74       <title>Notes</title>
  75       <para>
  76         <!-- notes -->
  77       </para>
  78     </refsect1>
  79   </refentry>
  80
  81   <refentry id="delete-large-object">
  82     <refnamediv>
  83       <refname>DELETE-LARGE-OBJECT</refname>
  84       <refpurpose><!-- purpose --></refpurpose>
  85       <refclass>Function</refclass>
  86     </refnamediv>
  87     <refsect1>
  88       <title>Syntax</title>
  89       <synopsis>
  90       <function> (DELETE-LARGE-OBJECT OBJECT-ID &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
  91     </refsect1>
  92     <refsect1>
  93       <title>Arguments and Values</title>
  94       <variablelist>
  95         <!-- arguments and values -->
  96       </variablelist>
  97     </refsect1>
  98     <refsect1>
  99       <title>Description</title>
 100       <para>Deletes the large object in the database
 101       </para>
 102     </refsect1>
 103     <refsect1>
 104       <title>Examples</title>
 105       <screen>
 106         <!-- examples -->
 107       </screen>
 108     </refsect1>
 109     <refsect1>
 110       <title>Side Effects</title>
 111       <para>
 112         <!-- side effects -->
 113       </para>
 114     </refsect1>
 115     <refsect1>
 116       <title>Affected by</title>
 117       <para>
 118         <simplelist>
 119           <!-- affected by -->
 120         </simplelist>
 121       </para>
 122     </refsect1>
 123     <refsect1>
 124       <title>Exceptional Situations</title>
 125       <para>
 126         <!-- execeptional situations -->
 127       </para>
 128     </refsect1>
 129     <refsect1>
 130       <title>See Also</title>
 131       <para>
 132         <simplelist>
 133           <!-- see also -->
 134         </simplelist>
 135       </para>
 136     </refsect1>
 137     <refsect1>
 138       <title>Notes</title>
 139       <para>
 140         <!-- notes -->
 141       </para>
 142     </refsect1>
 143   </refentry>
 144
 145   <refentry id="read-large-object">
 146     <refnamediv>
 147       <refname>READ-LARGE-OBJECT</refname>
 148       <refpurpose><!-- purpose --></refpurpose>
 149       <refclass>Function</refclass>
 150     </refnamediv>
 151     <refsect1>
 152       <title>Syntax</title>
 153       <synopsis>
 154       <function> (READ-LARGE-OBJECT OBJECT-ID &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 155     </refsect1>
 156     <refsect1>
 157       <title>Arguments and Values</title>
 158       <variablelist>
 159         <!-- arguments and values -->
 160       </variablelist>
 161     </refsect1>
 162     <refsect1>
 163       <title>Description</title>
 164       <para>Reads the large object content
 165       </para>
 166     </refsect1>
 167     <refsect1>
 168       <title>Examples</title>
 169       <screen>
 170         <!-- examples -->
 171       </screen>
 172     </refsect1>
 173     <refsect1>
 174       <title>Side Effects</title>
 175       <para>
 176         <!-- side effects -->
 177       </para>
 178     </refsect1>
 179     <refsect1>
 180       <title>Affected by</title>
 181       <para>
 182         <simplelist>
 183           <!-- affected by -->
 184         </simplelist>
 185       </para>
 186     </refsect1>
 187     <refsect1>
 188       <title>Exceptional Situations</title>
 189       <para>
 190         <!-- execeptional situations -->
 191       </para>
 192     </refsect1>
 193     <refsect1>
 194       <title>See Also</title>
 195       <para>
 196         <simplelist>
 197           <!-- see also -->
 198         </simplelist>
 199       </para>
 200     </refsect1>
 201     <refsect1>
 202       <title>Notes</title>
 203       <para>
 204         <!-- notes -->
 205       </para>
 206     </refsect1>
 207   </refentry>
 208
 209   <refentry id="write-large-object">
 210     <refnamediv>
 211       <refname>WRITE-LARGE-OBJECT</refname>
 212       <refpurpose><!-- purpose --></refpurpose>
 213       <refclass>Function</refclass>
 214     </refnamediv>
 215     <refsect1>
 216       <title>Syntax</title>
 217       <synopsis>
 218       <function> (WRITE-LARGE-OBJECT OBJECT-ID DATA &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
 219     </refsect1>
 220     <refsect1>
 221       <title>Arguments and Values</title>
 222       <variablelist>
 223         <!-- arguments and values -->
 224       </variablelist>
 225     </refsect1>
 226     <refsect1>
 227       <title>Description</title>
 228       <para>Writes data to the large object
 229       </para>
 230     </refsect1>
 231     <refsect1>
 232       <title>Examples</title>
 233       <screen>
 234         <!-- examples -->
 235       </screen>
 236     </refsect1>
 237     <refsect1>
 238       <title>Side Effects</title>
 239       <para>
 240         <!-- side effects -->
 241       </para>
 242     </refsect1>
 243     <refsect1>
 244       <title>Affected by</title>
 245       <para>
 246         <simplelist>
 247           <!-- affected by -->
 248         </simplelist>
 249       </para>
 250     </refsect1>
 251     <refsect1>
 252       <title>Exceptional Situations</title>
 253       <para>
 254         <!-- execeptional situations -->
 255       </para>
 256     </refsect1>
 257     <refsect1>
 258       <title>See Also</title>
 259       <para>
 260         <simplelist>
 261           <!-- see also -->
 262         </simplelist>
 263       </para>
 264     </refsect1>
 265     <refsect1>
 266       <title>Notes</title>
 267       <para>
 268         <!-- notes -->
 269       </para>
 270     </refsect1>
 271   </refentry>
 272
 273 </reference>