Package Exports
- @sib-swiss/sparql-editor
Readme
A user-friendly SPARQL query editor built on the popular YASGUI editor, it provides context-aware autocomplete for classes and predicates based on the content of the endpoints, as well as query examples.
Use it directly for any endpoint at sib-swiss.github.io/sparql-editor.
The editor retrieves metadata about the endpoints by directly querying them, or searching in the SPARQL service description. So all that is needed is to generate and upload some metadata to each endpoints, and it works on top of any triplestore without configuration needed. Reducing the need for complex infrastructure, while making your SPARQL endpoints easier to query for users and machines.
You can also redeploy it for a specific endpoint, or set of endpoints using the standard web component documented below,
πͺ Features
β¨ Autocomplete possibilities for properties and classes are automatically pulled from the endpoints based on the VoID description present in the triplestore. The suggested properties are contextually filtered based on the class of the subject at the cursor's position, and are aware of
SERVICE
clauses, ensuring relevant autocompletion even in federated queries. Checkout thevoid-generator
project to automatically generate VoID description for your endpoint.Click here to see the SPARQL query used to retrieve the VoID description.
PREFIX void: <http://rdfs.org/ns/void#> PREFIX void-ext: <http://ldf.fi/void-ext#> SELECT DISTINCT ?subjectClass ?prop ?objectClass ?objectDatatype WHERE { { ?cp void:class ?subjectClass ; void:propertyPartition ?pp . ?pp void:property ?prop . OPTIONAL { { ?pp void:classPartition [ void:class ?objectClass ] . } UNION { ?pp void-ext:datatypePartition [ void-ext:datatype ?objectDatatype ] . } } } UNION { ?linkset void:subjectsTarget ?subjectClass ; void:linkPredicate ?prop ; void:objectsTarget ?objectClass . } }
π Example SPARQL queries defined using the SHACL ontology are automatically pulled from the endpoint. Checkout the
sparql-examples
project for more details.Click here to see the SPARQL query used to retrieve the example queries.
PREFIX sh: <http://www.w3.org/ns/shacl#> PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#> SELECT DISTINCT ?sq ?comment ?query WHERE { ?sq a sh:SPARQLExecutable ; rdfs:comment ?comment ; sh:select|sh:ask|sh:construct|sh:describe ?query . } ORDER BY ?sq
π·οΈ Prefixes are automatically pulled from the endpoint using their definition defined with the SHACL ontology (
sh:prefix
/sh:namespace
).Click here to see the SPARQL query used to retrieve the prefixes/namespaces.
PREFIX sh: <http://www.w3.org/ns/shacl#> SELECT DISTINCT ?prefix ?namespace WHERE { [] sh:namespace ?namespace ; sh:prefix ?prefix } ORDER BY ?prefix
πΊοΈ Overview of classes using the VoID description.
π Use
Install with a package manager in your project:
npm i --save @sib-swiss/sparql-editor
And import in your JS/TS file with:
import "@sib-swiss/sparql-editor";
Or directly import from a CDN:
<script type="module" src="https://esm.sh/@sib-swiss/sparql-editor"></script>
Use the custom element in your HTML/JSX/TSX code:
<sparql-editor endpoint="https://sparql.uniprot.org/sparql/"></sparql-editor>
You can also pass a list of endpoints URLs separated by commas to enable users to choose from different endpoints:
<sparql-editor endpoint="https://sparql.uniprot.org/sparql/,https://www.bgee.org/sparql/"></sparql-editor>
[!WARNING]
Metadata are retrieved by a few lightweight queries sent from client-side JavaScript when the editor is initialized, so your SPARQL endpoints should accept CORS (either from *, which is recommended, or just from the URL where the editor is deployed)
βοΈ Available attributes
You can customize a few optional attributes when calling the custom element:
default-method
: the default method used by YASGUI to query the endpoints (GET or POST, default to GET)examples-repository
: the URL to the git repository where the query examples for this endpoint are stored (automatically generated fromexamples-repo-add-url
if you provide it),examples-repo-add-url
: the URL to directly add the query to the git repository where the query examples for this endpoint are stored through the GitHub web UIexamples-namespace
: the namespace used when saving a query as example (defaults to the endpoint URL + /.well-known/sparql-examples/ when not specified),examples-on-main-page
: the number of examples displayed on the main page (defaults to 10),add-limit
: the number of rows to be added as limit to the query before being sent, if no limit has been defined by the user (default to none)style="--btn-color / --btn-bg-color"
: buttons color.
<sparql-editor
endpoint="https://www.bgee.org/sparql/,https://sparql.uniprot.org/sparql/"
default-method="POST"
examples-repo-add-url="https://github.com/sib-swiss/sparql-examples/new/master/examples/Bgee"
examples-repository="https://github.com/sib-swiss/sparql-examples"
examples-namespace="https://sparql.uniprot.org/sparql/.well-known/sparql-examples/"
examples-on-main-page="10"
add-limit="10000"
style="--btn-color: white; --btn-bg-color: #00709b;"
></sparql-editor>
π Basic example
No need for a complex project you can integrate SPARQL editor in any HTML page by importing from a CDN!
Create a index.html
file with:
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>SPARQL editor dev</title>
<meta name="description" content="SPARQL editor demo page" />
<link rel="icon" type="image/png" href="https://upload.wikimedia.org/wikipedia/commons/f/f3/Rdf_logo.svg" />
<!-- Import the module from a CDN -->
<script type="module" src="https://unpkg.com/@sib-swiss/sparql-editor"></script>
</head>
<body>
<div>
<sparql-editor
endpoint="https://www.bgee.org/sparql/"
examples-repo-add-url="https://github.com/sib-swiss/sparql-examples/new/master/examples/Bgee"
examples-on-main-page="10"
style="--btn-color: white; --btn-bg-color: #00709b;"
></sparql-editor>
</div>
</body>
</html>
Then just open this HTML page in your favorite browser.
You can also start a basic web server with NodeJS or Python (recommended):
npx http-server
# or
python -m http.server
π§βπ» Contributing
Checkout CONTRIBUTING.md for more details on how to run this in development and make a contribution.
π€ Credits
Thanks to: