Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nbittich/tortank-js
Node addon to parse and manipulate n3/turtle data.
https://github.com/nbittich/tortank-js
rdf rdf-parser rdf-triples rdflib
Last synced: 18 days ago
JSON representation
Node addon to parse and manipulate n3/turtle data.
- Host: GitHub
- URL: https://github.com/nbittich/tortank-js
- Owner: nbittich
- License: mit
- Created: 2023-08-25T17:19:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-01T20:48:15.000Z (21 days ago)
- Last Synced: 2024-12-01T20:48:35.852Z (21 days ago)
- Topics: rdf, rdf-parser, rdf-triples, rdflib
- Language: Rust
- Homepage:
- Size: 137 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TortankJS
Node addon to parse and manipulate n3/turtle data.
Uses [Tortank](https://github.com/nbittich/tortank).
## Installation
### Using the prebuilt node addon (GLIBC)
This will only work if you are on linux and if you have GLIBC 2.31+ installed (check with `ldd --version`)
#### Example using docker
- `docker run --rm -it node:16-bookworm bash`
- `mkdir example && cd example`
- `npm init --yes`
- `npm i rdf-tortank-linux`
- `node`
- `const tortank = require('rdf-tortank-linux')`
### Using the prebuilt node addon (MUSL)
This will only work if you are on linux and if you have libc.musl-x86_64 installed (check with `ldd --version`)
#### Example using docker
- `docker run --rm -it node:16-bookworm bash`
- `mkdir example && cd example`
- `npm init --yes`
- `npm i rdf-tortank-linux-musl`
- `node`
- `const tortank = require('rdf-tortank-linux-musl')`
### Using Rust
This is the preferred solution to target a different platform.
1. Install [Rust](https://www.rust-lang.org/tools/install)
2. Install Node
3. Inside your project `npm i --save-dev cargo-cp-artifact rdf-tortank`
4. `node`
5. `const tortank = require('rdf-tortank')`
#### Example using docker
- `docker run --rm -it rust bash`
- `apt update && apt upgrade -y`
- `curl -fsSL https://deb.nodesource.com/setup_16.x | bash - && apt-get install -y nodejs`
- `mkdir example && cd example`
- `npm init --yes`
- `npm i --save-dev cargo-cp-artifact rdf-tortank`
- `node`
- `const tortank = require('rdf-tortank')`
## Documentation
### Statements
Filter a Model based on subject, predicate object. It uses same params as
examples below, except there is no rhsPath / rhsData.
```js
const data = `
@prefix foaf: .
[ foaf:name "Alice" ] foaf:knows [
foaf:name "Bob" ;
foaf:lastName "George", "Joshua" ;
foaf:knows [
foaf:name "Eve" ] ;
foaf:mbox ] .
`;
let params = {
lhsData: data, // string|undefined, if not provided use lhsPath
outputType: "n3", // js|n3|undefined, output type
extraPrefixes: { // also optionals, if you need more prefixes to be defined
ext: "http://example.org/show/",
},
wellKnownPrefix: undefined, // undefined | string, for anon nodes (https://www.w3.org/2011/rdf-wg/wiki/Skolemisation)
subject: undefined, // uri|undefined, to filter subjects (must be an absolute uri)
predicate: "", // rdf iri|undefined, to filter predicates (muts be an absolute uri)
object: '"Eve"', // rdf string | rdf iri | undefined, to filter objects
};
tortank.statements(params);
```
You can also use prefixes, assuming they are known by the model. In the previous example, you could also do this:
```js
let paramsWithPrefix = {
lhsData: data,
outputType: "js",
subject: undefined,
predicate: "foaf:lastName", // use prefix foaf
object: undefined // rdf string | rdf iri | undefined, to filter objects
};
tortank.statements(params);
```
### Difference
Creates a new, indepependent, model containing all the statements in the left model that are not in the right model.
```js
// diff between model a and model b, store result in a file
const paramsByPath = {
lhsPath: "./example/modelA.ttl", // string|undefined, to load the left model by file, if not provided, use lhsData
rhsPath: "./example/modelB.ttl", // string|undefined, to load the right model by file, if not provided, use rhsData
outputType: "n3", // either n3|json|undefined
outputFilePath: "/tmp/diff.ttl", // string|undefined, if you want to save output directly into a file
bufSize: 10 // number|undefined, optional, if outputFilePath is set, buffering
}
try {
tortank.difference(paramsByPath); // check content in /tmp/diff.ttl
}catch(e) {
console.log("error! ", e);
}
// diff between model a and model b, store result in memory as javascipt object
const lhsData = `
@prefix foaf: .
[ foaf:name "Alice" ] foaf:knows [
foaf:name "Bob" ;
foaf:lastName "George", "Joshua" ;
foaf:knows [
foaf:name "Eve" ] ;
foaf:mbox ] .
`;
const paramsByDataAndPath = {
lhsData, // string|undefined, to load the left model by file, if not provided, use lhsData
rhsPath: "./example/modelC.ttl", // string|undefined, to load the right model by file, if not provided, use rhsData
}
try {
let data = tortank.difference(paramsByDataAndPath);
console.log(data);
}catch(e) {
console.log("error! ", e);
}
```
### Intersection
Creates a new, indepependent, model containing all the statements in the left model that are also in the right model.
The parameters are exactly similar to difference (see example above).
```js
try {
tortank.intersection(paramsByDataAndPath);
}catch(e) {
console.log("error! ", e);
}
```
### Merge
Merge two models togeter.
The parameters are exactly similar to difference and intersection (see example above).
```js
try {
tortank.merge(paramsByDataAndPath);
}catch(e) {
console.log("error! ", e);
}
```
### Mapping Function for In-Memory js model
It is possible to provide a mapper function to transform each triple in the model to something else.
If the function returns null or undefined, the triple will be filtered.
It only works for outputType `js` and in memory model.
```js
const fun = (triple) => {
if (triple.object.value.includes("Eve")) {
triple.object.value = "Robert";
}
return triple;
};
const data = `
@prefix foaf: .
[ foaf:name "Alice" ] foaf:knows [
foaf:name "Bob" ;
foaf:lastName "George", "Joshua" ;
foaf:knows [
foaf:name "Eve" ] ;
foaf:mbox ] .
`;
let params = {
lhsData: data,
outputType: "js",
extraPrefixes: { // also optionals, if you need more prefixes to be defined
ext: "http://example.org/show/",
},
wellKnownPrefix: undefined,
subject: undefined,
predicate: "",
object: '"Eve"',
mapperFunction: fun
};
tortank.statements(params); // for example, but could be merge, difference,..
```