{"_id":"@comunica/query-sparql-ostrich","name":"@comunica/query-sparql-ostrich","dist-tags":{"next":"2.0.1-alpha.1.0","latest":"2.0.1-alpha.1.0"},"versions":{"2.0.1-alpha.1.0":{"name":"@comunica/query-sparql-ostrich","version":"2.0.1-alpha.1.0","description":"A Comunica engine for link traversal-based query evaluation","lsd:module":true,"main":"lib/index.js","typings":"lib/index","repository":{"type":"git","url":"git+https://github.com/comunica/comunica-feature-versioning.git#master"},"publishConfig":{"access":"public"},"sideEffects":false,"keywords":["comunica","sparql","engine","query","update","sparql engine","sparql query","sparql update","sparql 1.1","versioning","ostrich"],"license":"MIT","bin":{"comunica-sparql-ostrich":"bin/query.js","comunica-sparql-ostrich-http":"bin/http.js","comunica-dynamic-sparql-ostrich":"bin/query-dynamic.js"},"bugs":{"url":"https://github.com/comunica/comunica-feature-versioning/issues"},"homepage":"https://comunica.dev/","dependencies":{"@comunica/actor-init-query":"^2.4.3","@comunica/actor-query-operation-contextify-version":"2.0.1-alpha.1.0","@comunica/actor-rdf-resolve-quad-pattern-ostrich":"2.0.1-alpha.1.0","@comunica/config-query-sparql-versioning":"2.0.1-alpha.1.0","@comunica/query-sparql":"^2.4.3","@comunica/runner-cli":"^2.4.0"},"scripts":{"build":"npm run build:ts","build:ts":"node \"../../node_modules/typescript/bin/tsc\"","prepare":"comunica-compile-config config/config-default.json > engine-default.js"},"browser":{"./lib/index.js":"./lib/index-browser.js"},"gitHead":"cbb743e226f4e49654ad0388f7a88ddeb20163ae","_id":"@comunica/query-sparql-ostrich@2.0.1-alpha.1.0","_nodeVersion":"16.16.0","_npmVersion":"lerna/5.6.2/node@v16.16.0+x64 (darwin)","dist":{"integrity":"sha512-BbxO25EFlDpRiql99M5SNtASSKyekT612dBH7XmwfaGNROVcWaCenWKBksrLMMti/Kf1spEOMoyZ2+85c3Gj9g==","shasum":"2cbe700a29663115ad01ad030f9b53a74b8c06a2","tarball":"https://registry.npmjs.org/@comunica/query-sparql-ostrich/-/query-sparql-ostrich-2.0.1-alpha.1.0.tgz","fileCount":19,"unpackedSize":104328,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCvtnOZ7dWECzZhHmUgo+HZ9DbsBw1KV86PLRHdqUnW+QIgEyCZw0i0wWmIofJuPItyH9RzPlVEIQQtLNCLQukVyMs="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjY8v+ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmparg//d2FAfL41zIoKZlZKCuPWNIIx8RQ4dyFppuyJ8vxTr0JBvk+T\r\ncHk2F3K48odQILFf5WxjIRhVipKi9AtLmnRsb3ReeVQ0T4sSZedxphZWcQsu\r\n9cRAHnhnGtnhnMf1gpPWH8WmhiwpX45HBS26ef0Wv79GGhw/qg0F3i1SBiKY\r\nwjKbJB4aIpg9OnZsbqW5RLaTzOih/dE4mc2oC+L+wIJO8uRCnlWaj6fxFMLS\r\nknFkqZvMmGPU0goIyujF8ZxJ92AuomGs5kbpTtn6gcb4O38P8b/xUl2RCx93\r\n8+OpbItgjrazBS8Tstq769wu30KHnffZ2N9nlqkxANvBzzzI6yCb/anvCQ13\r\nQRU8x7X5FoAQSF2zqpNnnoky2dEWDH+2/QDIMZ9eByjvn3LQneyJy6psWJex\r\nMcG72Y2HuJpxjaaO2sAVRTNTFgQ22WuLhl21hp17vudqioN75JJaBo4YKh6J\r\n9Y+zMHbfdQWDKSyPFcreAVUm34Mlu3J/sViGJo7RPjSD5vE9nvDP/6D35FAi\r\nN4l5c67Eg/7ivGBvxxHWh45NzejDl4dHT1ifFBPihP6FDzJCzWg2BN9dK7eL\r\njOGHMD604+YUUfgwd7EnaPpOvmetQczz3pVKrJ2Sl7QnxFziPaPiXCvA8gas\r\nAkjbUxzc6hdge90Qs+CRs8ZKZKBnGOdvwNw=\r\n=dNx+\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"rubensworks","email":"rubensworks@gmail.com"},"directories":{},"maintainers":[{"name":"jeswr","email":"jmwright.045@gmail.com"},{"name":"joachimvh","email":"joachimvh@gmail.com"},{"name":"rubensworks","email":"rubensworks@gmail.com"},{"name":"rubenverborgh","email":"ruben@verborgh.org"},{"name":"dexagod","email":"dedecker.ruben@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/query-sparql-ostrich_2.0.1-alpha.1.0_1667484670695_0.9556706906291628"},"_hasShrinkwrap":false}},"time":{"created":"2022-11-03T14:11:10.627Z","2.0.1-alpha.1.0":"2022-11-03T14:11:10.884Z","modified":"2022-11-03T14:11:11.155Z"},"maintainers":[{"name":"jeswr","email":"jmwright.045@gmail.com"},{"name":"joachimvh","email":"joachimvh@gmail.com"},{"name":"rubensworks","email":"rubensworks@gmail.com"},{"name":"rubenverborgh","email":"ruben@verborgh.org"},{"name":"dexagod","email":"dedecker.ruben@gmail.com"}],"description":"A Comunica engine for link traversal-based query evaluation","homepage":"https://comunica.dev/","keywords":["comunica","sparql","engine","query","update","sparql engine","sparql query","sparql update","sparql 1.1","versioning","ostrich"],"repository":{"type":"git","url":"git+https://github.com/comunica/comunica-feature-versioning.git#master"},"bugs":{"url":"https://github.com/comunica/comunica-feature-versioning/issues"},"license":"MIT","readme":"# Comunica SPARQL OSTRICH\n\n[![npm version](https://badge.fury.io/js/%40comunica%2Fquery-sparql-ostrich.svg)](https://www.npmjs.com/package/@comunica/query-sparql-ostrich)\n[![Docker Pulls](https://img.shields.io/docker/pulls/comunica/query-sparql-ostrich.svg)](https://hub.docker.com/r/comunica/query-sparql-ostrich/)\n\nComunica SPARQL OSTRICH is a SPARQL query engine for JavaScript that enables versioned querying over [OSTRICH](https://github.com/rdfostrich/ostrich) archives.\n\nThis module is part of the [Comunica framework](https://comunica.dev/).\n\n## Install\n\n```bash\n$ yarn add @comunica/query-sparql-ostrich\n```\n\nor\n\n```bash\n$ npm install -g @comunica/query-sparql-ostrich\n```\n\n## Install a prerelease\n\nSince this package is still in testing phase, you may want to install a prerelease of this package, which you can do by appending `@next` to the package name during installation.\n\n```bash\n$ yarn add @comunica/query-sparql-ostrich@next\n```\n\nor\n\n```bash\n$ npm install -g @comunica/query-sparql-ostrich@next\n```\n\n## Usage\n\nShow 100 triples from an OSTRICH store at version 1:\n\n```bash\n$ comunica-sparql-ostrich ostrichFile@dataset.ostrich \\\n  \"SELECT * WHERE {\n    GRAPH <version:1> {\n      ?s ?p ?o\n    }\n  } LIMIT 100\"\n```\n\nShow the help with all options:\n\n```bash\n$ comunica-sparql-ostrich --help\n```\n\nJust like [Comunica SPARQL](https://github.com/comunica/comunica/tree/master/packages/query-sparql),\na [dynamic variant](https://github.com/comunica/comunica/tree/master/packages/query-sparql#usage-from-the-command-line) (`comunica-dynamic-sparql-ostrich`) also exists.\n\n_[**Read more** about querying from the command line](https://comunica.dev/docs/query/getting_started/query_cli/)._\n\n### Usage within application\n\nThis engine can be used in JavaScript/TypeScript applications as follows:\n\n```javascript\nconst QueryEngine = require('@comunica/query-sparql-ostrich').QueryEngine;\nconst myEngine = new QueryEngine();\n\nconst bindingsStream = await myEngine.queryBindings(`\n  SELECT * WHERE {\n    GRAPH <version:1> {\n      ?s ?p ?o\n    }\n  } LIMIT 100`, {\n    sources: [{ type: 'ostrichFile', value: 'dataset.ostrich' }],\n    lenient: true,\n});\n\n// Consume results as a stream (best performance)\nbindingsStream.on('data', (binding) => {\n    console.log(binding.toString()); // Quick way to print bindings for testing\n\n    console.log(binding.has('s')); // Will be true\n\n    // Obtaining values\n    console.log(binding.get('s').value);\n    console.log(binding.get('s').termType);\n    console.log(binding.get('p').value);\n    console.log(binding.get('o').value);\n});\nbindingsStream.on('end', () => {\n    // The data-listener will not be called anymore once we get here.\n});\nbindingsStream.on('error', (error) => {\n    console.error(error);\n});\n\n// Consume results as an array (easier)\nconst bindings = await bindingsStream.toArray();\nconsole.log(bindings[0].get('s').value);\nconsole.log(bindings[0].get('s').termType);\n```\n\n_[**Read more** about querying an application](https://comunica.dev/docs/query/getting_started/query_app/)._\n\n### Usage as a SPARQL endpoint\n\nStart a webservice exposing an OSTRICH dataset via the SPARQL protocol, i.e., a _SPARQL endpoint_.\n\n```bash\n$ comunica-sparql-ostrich-http ostrichFile@dataset.ostrich\n```\n\nShow the help with all options:\n\n```bash\n$ comunica-sparql-ostrich-http --help\n```\n\nThe SPARQL endpoint can only be started dynamically.\nAn alternative config file can be passed via the `COMUNICA_CONFIG` environment variable.\n\nUse `bin/http.js` when running in the Comunica monorepo development environment.\n\n_[**Read more** about setting up a SPARQL endpoint](https://comunica.dev/docs/query/getting_started/setup_endpoint/)._\n","readmeFilename":"README.md"}