/comunica-actor-init-sparql-hdt

📬 A Comunica engine for SPARQL query evaluation over HDT files

Primary LanguageTypeScriptOtherNOASSERTION

Comunica SPARQL HDT Init Actor

Build Status npm version Greenkeeper badge

A comunica SPARQL HDT Init Actor.

This module is part of the Comunica framework.

Install

HDT requires GCC 4.9 or higher to be available.

$ yarn add global @comunica/actor-init-sparql-hdt

or

$ npm install -g @comunica/actor-init-sparql-hdt

Usage from the command line

Show 100 triples from a HDT file:

$ comunica-sparql-hdt hdtFile@myfile.hdt "CONSTRUCT WHERE { ?s ?p ?o } LIMIT 100"

Show the help with all options:

$ comunica-sparql-hdt --help

Just like Comunica SPARQL, a dynamic variant (comunica-dynamic-sparql-hdt) also exists.

Usage within application

This engine can be used in JavaScript/TypeScript applications as follows:

const newEngine = require('@comunica/actor-init-sparql-hdt').newEngine;
const myEngine = newEngine();

const result = await myEngine.query('SELECT * WHERE { ?s ?p <http://dbpedia.org/resource/Belgium>. ?s ?p ?o } LIMIT 100',
  { sources: [ { type: 'hdtFile', value: '/path/to/my/file.hdt' } ] })
result.bindingsStream.on('data', (data) => console.log(data.toObject()));

More details

Usage as a SPARQL endpoint

Start a webservice exposing http://fragments.dbpedia.org/2015-10/en via the SPARQL protocol, i.e., a SPARQL endpoint.

$ comunica-sparql-hdt-http "{ \"sources\": [{ \"type\": \"file\", \"value\" : \"/path/to/my/file.hdt" }]}"

Show the help with all options:

$ comunica-sparql-hdt-http --help

The SPARQL endpoint can only be started dynamically. An alternative config file can be passed via the COMUNICA_CONFIG environment variable.

Use bin/http.js when running in the GitHub repo.