MPSPARQL-24: Documentation: Add overview comments to the config file

[mp-sparql-moved-to-github.git] / bibframe / triplestore.xml

diff --git a/bibframe/triplestore.xml b/bibframe/triplestore.xml
index ac5b492..12af0dd 100644 (file)
--- a/bibframe/triplestore.xml
+++ b/bibframe/triplestore.xml
@@ -1,5 +1,38 @@
 <?xml version="1.0"?>
 
+<!-- 
+Mp-sparql example configuration
+
+This config file snippet is typically included from the main Metaproxy
+configuration. It sets up a simple chain that consists of the sparql 
+filter to translate the queries etc, and a http_client filter that is used
+to do the actual communication to the triple store.
+
+This config provides quite many databases, one for each major type of
+records. The most important are "work" and "instance". These have a great
+number of indexes.  There is a number of "small" databases like "person",
+"meeting" and "topic". These have one main index, named after the database
+name, for example "bf.person".  The "node" database can search for any node
+in the database, and "info" returns simple information about available
+databases.
+
+There are other databases defined in this file, but they are only used 
+internally, to be included in the real database definitions. All real,
+searchable databases have
+  schema="sparql-results"
+in the db tag, whereas those for include use only do not.
+
+All databases support the BF-L ("Link") schema, which returns the triples 
+of the nodes found in the database, without expanding anything. Most of them 
+also support BF-V ("Verbose") schema that expands those links to return a set
+of triples that is more or less self contained. A work, its instances, titles
+for all of them, authors, and their names, etc.
+
+
+
+
+-->
+
 <filters  xmlns="http://indexdata.com/metaproxy">
     <filter type="sparql">
 
@@ -17,7 +50,7 @@
 
             <!-- bf.uri is a simple way to get to a thing -->
             <index type="bf.uri">
-                ?thing  rdf:type ?any FILTER( ?thing  = %u )
+                ?thing  %v_rel %v_obj FILTER( ?thing  = %u )
             </index>
 
             <!-- bf.type is a simple way to search for types -->
@@ -26,6 +59,14 @@
                 ?thing  a %t
             </index>
 
+            <!-- Find all nodes that refer to the given uri -->
+            <!-- useful after finding uris in the "small" bases -->
+            <!-- direct references only -->
+            <index type="bf.ref">
+                ?thing %v_rel %u
+            </index>
+
+
             <!-- The BF-L present format is the same for everything -->
             <!-- Each db is supposed to provide a dedicated BF-V present format -->
             <present type="BF-L">
@@ -48,7 +89,7 @@
         <!-- This way, we use a different variable for each index clause, and -->
         <!-- do not get into trouble if we have an AND between two of the same kind -->
         <db path="smallindex">
-            <index type="bf.personX">
+            <index type="bf.person">
                 ?thing ?rel %vx .
                 %vx a bf:Person .
                 %vx bf:label %v FILTER(contains(%v, %s))
@@ -201,6 +242,11 @@
                 ?thing bf:contentCategory %u
             </index>
 
+            <!-- Find the work that has a given Instance -->
+            <index type="bf.instance">
+                %v_inst bf:instanceOf ?thing FILTER ( %v_inst = %u)
+            </index>
+
             <!-- Present formats -->
             <!-- BF-L comes from the "thing" template -->
             <!-- BF-V expands all links, even to instances but not other works -->
@@ -376,7 +422,7 @@
                     %v_isbn bf:identifierValue  %v FILTER( %v = %s )
                 }
             </index>
-            
+
             <!-- lccn number, a simpler index for id numbers -->
             <index type="bf.lccn">
                 ?thing bf:lccn %v_lccn .
@@ -384,6 +430,11 @@
                 %v_lccn bf:identifierValue  %v FILTER( %v = %s )
             </index>
 
+            <!-- Find the instances of a given work -->
+            <index type="bf.work">
+                ?thing bf:instanceOf %u
+            </index>
+
 
             <!-- Present formats. BF-L comes from "thing" -->
             <!-- Full instance, with the related work too -->
@@ -551,22 +602,17 @@
         </db>
 
         <!-- A hack to be able to look at any triplet in the base -->
+        <!-- The indexes bf.uri and bf.ref can also come in handy here -->
         <db path="node" schema="sparql-results" include="smallbody">
             <index type="any">
                 ?thing ?rel ?obj FILTER( str(?thing) = %s )
             </index>
         </db>
-        <!-- A way to see which triplets refers to a given uri. -->
-        <db path="ref" schema="sparql-results" include="smallbody">
-            <index type="any">
-                ?thing ?rel ?obj FILTER( str(?obj) = %s )
-            </index>
-        </db>
+
     </filter>
 
     <filter type="log">
         <message>http</message>
-        <category apdu="true"/>
     </filter>
 
     <filter type="http_client">