X-Git-Url: http://git.indexdata.com/?p=mp-sparql-moved-to-github.git;a=blobdiff_plain;f=doc%2Fsparql.xml;h=a43fbaedb7bfa0814fa9e964788899b39ab1e255;hp=afce82bb23e27620cea6b4bea3f21864f41966c9;hb=43063c1e0a4e9d1cf9347d7bdefe8ee99dbb14cb;hpb=876978c2d978e86cc7bae354ae356e07a2bf389e
diff --git a/doc/sparql.xml b/doc/sparql.xml
index afce82b..a43fbae 100644
--- a/doc/sparql.xml
+++ b/doc/sparql.xml
@@ -26,15 +26,32 @@
HTTP requests that accesses a remote triplestore via HTTP
- Configuration consists of one or more db elements. Each db element
- describes how to access a specific database. The db element takes
- attributes name of Z39.50 database (path) and
- HTTP access point of triplestore (uri).
- Optionally, the schema for the database may be given with attribute
- schema.
- Each
- db element takes these elements:
- Configurable values:
+ This module only inspects Z39.50. HTTP requests are ignored (passed through).
+ When this module is in effect, the result is HTTP packages. Use
+ the http_client module after this module in the
+ route in order to contact a remote triplestore via HTTP
+
+
+ Configuration consists of an optional defaults section and one or more
+ database sections.
+
+
+ The default sections is defined with element defaults
+ and specifies the URL of the triplestore by attribute
+ uri.
+
+
+ A database section is defined with element db.
+ The db element must specify attribute
+ path which is the name of the Z39.50 database.
+ It should also include attribute uri with the
+ URL of the triplestore; unless already specified in the detaults
+ section.
+ The element-set-name / schema for the database may be given with
+ attribute schema.
+ A db configuration may also include settings from another db section -
+ specified by the include attribute.
+ Each database section takes these elements:
<prefix/>
@@ -47,7 +64,7 @@
<form/>
- SPARQL Query formulation selection. SHould start with one of the
+ SPARQL Query formulation selection. Should start with one of the
query forms: SELECT or CONSTRUCT.
@@ -67,21 +84,22 @@
<index type="attribute"/>
- Section used to declare RPN use attribute strings (indexes) and map
- them to BIBFRAME graph patterns.
- Items in this section are expanded during RPN query processing and
- placeholders (%s, %d,
- %t) are substituted with query terms.
- To map a given CQL index (e.g the default keyword index) into
- multiple entity properties, SPARQL constructs like
- `OPTIONAL` or `UNION` could be used.
+ Section used to declare RPN/Type-1 use attribute strings (indices)
+ and map them to BIBFRAME graph patterns.
+ Items in this section are constructed during RPN query processing and
+ placeholders that are prefixed by a percent sign (%)
+ are expanded.
+ See EXPANSIONS.
+ To map a given use attribute (search field) into
+ multiple entity properties, SPARQL constructs like `OPTIONAL` or
+ `UNION` can be used.
<present type="attribute"/>
- Section used to declare retrieval for a given element-set
+ Section used to declare retrieval for a given element-set-name
(SRU schema). The CDATA is SPARQL where %u holds
the URI of the record. This can be used to construct the resulting
record.
@@ -100,9 +118,50 @@
-
- SCHEMA
- EXPANSIONS
+
+ %t
+
+
+ The term verbatim as it appears in the Type-1 query.
+
+
+
+ %s
+
+
+ Like %t but quoted - for general strings.
+
+
+
+ %d
+
+
+ Term - expecting an integer.
+
+
+
+ %u
+
+
+ Like %t, but with prefix <
+ and suffix > - for URIs.
+
+
+
+ %v
+
+
+ Expands to a SPARQL local variable ?v.... Allows
+ the use of a local SPARQL variable for each Attribute+Term in the
+ Type-1 query.
+
+
+
+
+
+ SCHEMA
+
@@ -118,7 +177,6 @@
- rdf: http://www.w3.org/1999/02/22-rdf-syntax-ns
bf: http://bibframe.org/vocab/
?work a bf:Work
@@ -140,7 +198,6 @@
the same filter section as the "Default" db above.
- rdf: http://www.w3.org/1999/02/22-rdf-syntax-ns
bf: http://bibframe.org/vocab/
@@ -197,7 +255,6 @@
Configuration for database "works". This uses CONSTRUCT to produce rdf.
- rdf: http://www.w3.org/1999/02/22-rdf-syntax-ns
bf: http://bibframe.org/vocab/