From: Mike Taylor <mike@indexdata.com>
Date: Tue, 16 May 2006 10:32:54 +0000 (+0000)
Subject: Describe <hideunavailable>
X-Git-Tag: METAPROXY.1.0.4~2
X-Git-Url: http://lists.indexdata.dk/?a=commitdiff_plain;h=1700f4d992fbbc7ec607ed1daa1228cdb7dc251f;p=metaproxy-moved-to-github.git

Describe <hideunavailable>
---

diff --git a/doc/book.xml b/doc/book.xml
index b3ab960..384e1a7 100644
--- a/doc/book.xml
+++ b/doc/book.xml
@@ -1,4 +1,4 @@
-<!-- $Id: book.xml,v 1.30 2006-05-03 14:56:07 mike Exp $ -->
+<!-- $Id: book.xml,v 1.31 2006-05-16 10:32:54 mike Exp $ -->
  <bookinfo>
   <title>Metaproxy - User's Guide and Reference</title>
   <author>
@@ -1184,6 +1184,27 @@ Z>
     be metasearched in this way: issues of resource usage and
     administrative complexity dictate the practical limits.
    </para>
+   <para>
+    What happens when one of the databases doesn't respond?  By default,
+    the entire multi-database search fails, and the appropriate
+    diagnostic is returned to the client.  This is usually appropriate
+    during development, when technicians need maximum information, but
+    can be inconvenient in deployment, when users typically don't want
+    to be bothered with problems of this kind and prefer just to get
+    the records from the databases that are available.  To obtain this
+    latter behaviour add an empty
+    <literal>&lt;hideunavailable&gt;</literal>
+    element inside the
+    <literal>&lt;multi&gt;</literal>:
+   </para>
+   <screen><![CDATA[      <filter type="multi">
+        <hideunavailable/>
+      </filter>]]></screen>
+   <para>
+    Under this regime, an error is reported to the client only if
+    <emphasis>all</emphasis> the databases in a multi-database search
+    are unavailable.
+   </para>
   </section>
 
 
diff --git a/doc/multi.xml b/doc/multi.xml
index 54afb63..201844e 100644
--- a/doc/multi.xml
+++ b/doc/multi.xml
@@ -2,7 +2,7 @@
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
 ]>
-<!-- $Id: multi.xml,v 1.4 2006-04-25 12:48:52 marc Exp $ -->
+<!-- $Id: multi.xml,v 1.5 2006-05-16 10:36:51 mike Exp $ -->
 <refentry>
  <refmeta>
   <refentrytitle>multi</refentrytitle>
@@ -30,6 +30,15 @@
 ]]>
    </screen>
   </para>
+  <para>
+   If an empty
+   <literal>&lt;hideunavailable&gt;</literal>
+   element is placed inside the
+   <literal>multi</literal>
+   filter, then unavailable databases are not reported to the client,
+   but simply ignored (unless every one of the databases is
+   unanavailable).
+  </para>
  </refsect1> 
  
  <refsect1><title>SEE ALSO</title>