diff options
Diffstat (limited to 'doc/ref-lob.xml')
| -rw-r--r-- | doc/ref-lob.xml | 273 |
1 files changed, 273 insertions, 0 deletions
diff --git a/doc/ref-lob.xml b/doc/ref-lob.xml new file mode 100644 index 0000000..4ca04ff --- /dev/null +++ b/doc/ref-lob.xml @@ -0,0 +1,273 @@ +<?xml version='1.0' ?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % myents SYSTEM "entities.inc"> +%myents; +]> + +<reference id="ref-lob"> + <title>Large Object Support</title> + <partintro> + <para> + <!-- introduction --> + </para> + </partintro> + + <refentry id="create-large-object"> + <refnamediv> + <refname>CREATE-LARGE-OBJECT</refname> + <refpurpose><!-- purpose --></refpurpose> + <refclass>Function</refclass> + </refnamediv> + <refsect1> + <title>Syntax</title> + <synopsis> + <function> (CREATE-LARGE-OBJECT &KEY (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis> + </refsect1> + <refsect1> + <title>Arguments and Values</title> + <variablelist> + <!-- arguments and values --> + </variablelist> + </refsect1> + <refsect1> + <title>Description</title> + <para>Creates a new large object in the database and returns + the object identifier + </para> + </refsect1> + <refsect1> + <title>Examples</title> + <screen> + <!-- examples --> + </screen> + </refsect1> + <refsect1> + <title>Side Effects</title> + <para> + <!-- side effects --> + </para> + </refsect1> + <refsect1> + <title>Affected by</title> + <para> + <simplelist> + <!-- affected by --> + </simplelist> + </para> + </refsect1> + <refsect1> + <title>Exceptional Situations</title> + <para> + <!-- execeptional situations --> + </para> + </refsect1> + <refsect1> + <title>See Also</title> + <para> + <simplelist> + <!-- see also --> + </simplelist> + </para> + </refsect1> + <refsect1> + <title>Notes</title> + <para> + <!-- notes --> + </para> + </refsect1> + </refentry> + + <refentry id="delete-large-object"> + <refnamediv> + <refname>DELETE-LARGE-OBJECT</refname> + <refpurpose><!-- purpose --></refpurpose> + <refclass>Function</refclass> + </refnamediv> + <refsect1> + <title>Syntax</title> + <synopsis> + <function> (DELETE-LARGE-OBJECT OBJECT-ID &KEY (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis> + </refsect1> + <refsect1> + <title>Arguments and Values</title> + <variablelist> + <!-- arguments and values --> + </variablelist> + </refsect1> + <refsect1> + <title>Description</title> + <para>Deletes the large object in the database + </para> + </refsect1> + <refsect1> + <title>Examples</title> + <screen> + <!-- examples --> + </screen> + </refsect1> + <refsect1> + <title>Side Effects</title> + <para> + <!-- side effects --> + </para> + </refsect1> + <refsect1> + <title>Affected by</title> + <para> + <simplelist> + <!-- affected by --> + </simplelist> + </para> + </refsect1> + <refsect1> + <title>Exceptional Situations</title> + <para> + <!-- execeptional situations --> + </para> + </refsect1> + <refsect1> + <title>See Also</title> + <para> + <simplelist> + <!-- see also --> + </simplelist> + </para> + </refsect1> + <refsect1> + <title>Notes</title> + <para> + <!-- notes --> + </para> + </refsect1> + </refentry> + + <refentry id="read-large-object"> + <refnamediv> + <refname>READ-LARGE-OBJECT</refname> + <refpurpose><!-- purpose --></refpurpose> + <refclass>Function</refclass> + </refnamediv> + <refsect1> + <title>Syntax</title> + <synopsis> + <function> (READ-LARGE-OBJECT OBJECT-ID &KEY (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis> + </refsect1> + <refsect1> + <title>Arguments and Values</title> + <variablelist> + <!-- arguments and values --> + </variablelist> + </refsect1> + <refsect1> + <title>Description</title> + <para>Reads the large object content + </para> + </refsect1> + <refsect1> + <title>Examples</title> + <screen> + <!-- examples --> + </screen> + </refsect1> + <refsect1> + <title>Side Effects</title> + <para> + <!-- side effects --> + </para> + </refsect1> + <refsect1> + <title>Affected by</title> + <para> + <simplelist> + <!-- affected by --> + </simplelist> + </para> + </refsect1> + <refsect1> + <title>Exceptional Situations</title> + <para> + <!-- execeptional situations --> + </para> + </refsect1> + <refsect1> + <title>See Also</title> + <para> + <simplelist> + <!-- see also --> + </simplelist> + </para> + </refsect1> + <refsect1> + <title>Notes</title> + <para> + <!-- notes --> + </para> + </refsect1> + </refentry> + + <refentry id="write-large-object"> + <refnamediv> + <refname>WRITE-LARGE-OBJECT</refname> + <refpurpose><!-- purpose --></refpurpose> + <refclass>Function</refclass> + </refnamediv> + <refsect1> + <title>Syntax</title> + <synopsis> + <function> (WRITE-LARGE-OBJECT OBJECT-ID DATA &KEY (DATABASE *DEFAULT-DATABASE*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis> + </refsect1> + <refsect1> + <title>Arguments and Values</title> + <variablelist> + <!-- arguments and values --> + </variablelist> + </refsect1> + <refsect1> + <title>Description</title> + <para>Writes data to the large object + </para> + </refsect1> + <refsect1> + <title>Examples</title> + <screen> + <!-- examples --> + </screen> + </refsect1> + <refsect1> + <title>Side Effects</title> + <para> + <!-- side effects --> + </para> + </refsect1> + <refsect1> + <title>Affected by</title> + <para> + <simplelist> + <!-- affected by --> + </simplelist> + </para> + </refsect1> + <refsect1> + <title>Exceptional Situations</title> + <para> + <!-- execeptional situations --> + </para> + </refsect1> + <refsect1> + <title>See Also</title> + <para> + <simplelist> + <!-- see also --> + </simplelist> + </para> + </refsect1> + <refsect1> + <title>Notes</title> + <para> + <!-- notes --> + </para> + </refsect1> + </refentry> + +</reference> |