Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rubensworks committed Nov 3, 2022
1 parent ad98e47 commit e0a12b8
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 19 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,20 @@
This is a monorepo that contains packages for allowing [Comunica](https://github.com/comunica/comunica) to query over RDF archives that contain multiple versions of a dataset.
If you want to _use_ an versioning-enabled Comunica engine, have a look at [Comunica SPARQL OSTRICH](https://github.com/comunica/comunica-feature-versioning/tree/master/engines/query-sparql-ostrich).

Concretely, link traversal is enabled in the following engines:
Concretely, versioning is enabled in the following engines:

* Query engine configurations:
* [Comunica SPARQL OSTRICH](https://github.com/comunica/comunica-feature-versioning/tree/master/engines/query-sparql-ostrich): A Comunica query engine that enables versioned querying over [OSTRICH](https://github.com/rdfostrich/ostrich) archives.

These engines make use of the following packages:

TODO
* Quad Pattern Resolving:
* [OSTRICH](https://github.com/comunica/comunica-feature-versioning/tree/master/packages/actor-rdf-resolve-quad-pattern-ostrich): Resolves quad patterns to OSTRICH stores.
* Query Operation:
* [Contextify Version](https://github.com/comunica/comunica-feature-versioning/tree/master/packages/actor-query-operation-contextify-version): Rewrites queries by assuming named graphs references to versions.
* Other:
* [Context entries](https://github.com/comunica/comunica-feature-versioning/tree/master/packages/context-entries-versioning): Reusable context key definitions for versioning.
* [Types](https://github.com/comunica/comunica-feature-versioning/tree/master/packages/types-versioning): Reusable Typescript interfaces and types for versioning.

**Warning: All packages in this repo should be considered unstable, and breaking changes may occur at any time.**

Expand Down
32 changes: 15 additions & 17 deletions engines/query-sparql-ostrich/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,15 @@ $ npm install -g @comunica/query-sparql-ostrich@next

## Usage

**TODO: update me**

Show 100 triples from http://fragments.dbpedia.org/2015-10/en:
Show 100 triples from an OSTRICH store at version 1:

```bash
$ comunica-sparql-ostrich https://www.rubensworks.net/ \
"SELECT DISTINCT * WHERE {
<https://www.rubensworks.net/#me> <http://xmlns.com/foaf/0.1/knows> ?p.
<https://ruben.verborgh.org/profile/#me> <http://xmlns.com/foaf/0.1/knows> ?p.
?p <http://xmlns.com/foaf/0.1/name> ?name.
}" --lenient
$ comunica-sparql-ostrich [email protected] \
"SELECT * WHERE {
GRAPH <version:1> {
?s ?p ?o
}
} LIMIT 100"
```

Show the help with all options:
Expand All @@ -68,12 +66,12 @@ const QueryEngine = require('@comunica/query-sparql-ostrich').QueryEngine;
const myEngine = new QueryEngine();

const bindingsStream = await myEngine.queryBindings(`
SELECT DISTINCT * WHERE {
<https://www.rubensworks.net/#me> <http://xmlns.com/foaf/0.1/knows> ?p.
<https://ruben.verborgh.org/profile/#me> <http://xmlns.com/foaf/0.1/knows> ?p.
?p <http://xmlns.com/foaf/0.1/name> ?name.
}`, {
sources: ['https://www.rubensworks.net/'],
SELECT * WHERE {
GRAPH <version:1> {
?s ?p ?o
}
} LIMIT 100`, {
sources: [{ type: 'ostrichFile', value: 'dataset.ostrich' }],
lenient: true,
});

Expand Down Expand Up @@ -106,10 +104,10 @@ _[**Read more** about querying an application](https://comunica.dev/docs/query/g

### Usage as a SPARQL endpoint

Start a webservice exposing https://www.rubensworks.net/ via the SPARQL protocol, i.e., a _SPARQL endpoint_.
Start a webservice exposing an OSTRICH dataset via the SPARQL protocol, i.e., a _SPARQL endpoint_.

```bash
$ comunica-sparql-ostrich-http https://www.rubensworks.net/ --lenient
$ comunica-sparql-ostrich-http [email protected]
```

Show the help with all options:
Expand Down

0 comments on commit e0a12b8

Please sign in to comment.