X-Git-Url: http://git.indexdata.com/?p=mp-sparql-moved-to-github.git;a=blobdiff_plain;f=doc%2Fsparql.xml;fp=doc%2Fsparql.xml;h=838dce1cb4b52dd1340bdf0c12fe860cdc4a62c7;hp=0000000000000000000000000000000000000000;hb=fd951f5b39fc73d6f4d97b93965ec1f3b6d9407b;hpb=b3d40be50ad3db94f37ca8c49886ce1d222da85a diff --git a/doc/sparql.xml b/doc/sparql.xml new file mode 100644 index 0000000..838dce1 --- /dev/null +++ b/doc/sparql.xml @@ -0,0 +1,127 @@ + + + + Metaproxy SPARQL module + Index Data + + + + sparql + 3mp + Metaproxy Module + + + + sparql + + Metaproxy Module for accessing a triplestore + + + + DESCRIPTION + + This module translates Z39.50 operations init, search, present to + 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). Each + db element takes these elements: + Configurable values: + + <prefix/> + + + Section that maps prefixes and namespaces for RDF vocabularies. + The format is prefix followed by colon, followed by value. + + + + <field/> + + + Optional section for controlling what data rows are selected in the + SPARQL statement and how they are mapped to the output document, all + variables (\*) are selected when none is provided. + + + + <criteria/> + + + section that allows to map static graph patterns for binding + variables, narrowing types, etc, or any other WHERE clause criteria + static to the Z39.50/SRU database. The final query conversion logic + should be able to deduce which optional criteria should be included + in the generated SPARQL by analyzing variables required in the query + matching and display fields. + + + + <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) 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. + + + + + + + + SCHEMA + + + + + EXAMPLES + + Configuration for database "Default" that allows searching works. Only + the field (use attribute) "bf.wtitle" is supported. + + + rdf: http://www.w3.org/1999/02/22-rdf-syntax-ns + bf: http://bibframe.org/vocab/ + ?work ?wtitle + ?work a bf:Work + ?work bf:workTitle ?wt + ?wt bf:titleValue ?wtitle + ?wt bf:titleValue %v FILTER(contains(%v, %s)) + + +]]> + + + + + SEE ALSO + + + metaproxy + 1 + + + + + + +