Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/levelgraph/levelgraph-n3
LevelGraph plugin for storing N3/Turtle/RDF data
https://github.com/levelgraph/levelgraph-n3
Last synced: about 1 month ago
JSON representation
LevelGraph plugin for storing N3/Turtle/RDF data
- Host: GitHub
- URL: https://github.com/levelgraph/levelgraph-n3
- Owner: levelgraph
- Created: 2013-07-07T17:52:06.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2020-01-29T21:31:24.000Z (almost 5 years ago)
- Last Synced: 2024-10-12T16:58:27.382Z (2 months ago)
- Language: JavaScript
- Size: 186 KB
- Stars: 36
- Watchers: 11
- Forks: 8
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-starred - levelgraph/levelgraph-n3 - LevelGraph plugin for storing N3/Turtle/RDF data (others)
README
LevelGraph-N3
===========
[](https://travis-ci.org/levelgraph/levelgraph-n3)
[](https://coveralls.io/r/levelgraph/levelgraph-n3)
[](https://david-dm.org/levelgraph/levelgraph-n3)
[](https://saucelabs.com/u/levelgraph-n3)
__LevelGraph-N3__ is a plugin for
[LevelGraph](http://github.com/levelgraph/levelgraph) that adds the
ability to store, fetch and process N3 and turtle files.
## Install
### Node.js
Adding support for N3 to LevelGraph is easy:
```shell
$ npm install level levelgraph levelgraph-n3 --save
```
Then in your code:
```js
var level = require('level'),
levelgraph = require('levelgraph'),
levelgraphN3 = require('levelgraph-n3'),
db = levelgraphN3(levelgraph(level('yourdb')));
```
### Browser
If you use [browserify](http://browserify.org/) you can use this package
in a browser just as in node.js. Please also take a look at [Browserify
section in LevelGraph package](https://github.com/levelgraph/levelgraph#browserify)
## Usage
We assume in following examples that you created database as explained
above!
```js
var db = levelgraphN3(levelgraph(level("yourdb")));
```
### Importing n3 files
In code:
```js
var fs = require("fs");
var stream = fs.createReadStream("./triples.n3")
.pipe(db.n3.putStream());
stream.on("finish", function() {
console.log("Import completed");
});
```
Alternatively, you can run the import CLI tool by running `npm install`, then:
```
./import.js path/to/n3/file(s)
```
with the following optional flags:
`-o` or `--output` followed by the desired DB path. If not specified, path will be at `./db`.
`-q` or `--quiet` will silence status updates during the import process. Otherwise, progress information is displayed.
File extensions must be `.n3` or `.nt`. Additionally, there is glob support, so for example `*.nt` will import all the matching n-triple files.
### Get and Put
Storing an N3 file in the database is extremey easy:
```js
var turtle = "@prefix c: .\n" +
"c:Tom a c:Cat.\n" +
"c:Jerry a c:Mouse;\n" +
" c:smarterThan c:Tom;\n" +
" c:place \"fantasy\".";
db.n3.put(turtle, function(err) {
// do something after the triple is inserted
});
```
Retrieving it through pattern-matching is extremely easy:
```js
db.n3.get({ subject: "http://example.org/cartoons#Tom" }, function(err, turtle) {
// turtle is " a .\n";
});
```
It even support a Stream interface:
```js
var stream = db.n3.getStream({ subject: "http://example.org/cartoons#Tom" });
stream.on("data", function(data) {
// data is " a .\n";
});
stream.on("end", done);
```
### Exporting NTriples from LevelGraph
__LevelGraph-N3__ allows to export ntriples from a __LevelGraph__ database.
__LevelGraph-N3__ augments the a standard `search` method with a `{ n3: ... }` option
that specifies the subject, predicate and object of the created triples.
It follows the same structure of the `{ materialized: ... }` option (see https://github.com/levelgraph/levelgraph#searches).
Here is an example:
```js
db.search([{
subject: db.v("s"),
predicate: "http://example.org/cartoons#smarterThan",
object: db.v("o")
}], {
n3: {
subject: db.v("o"),
predicate: "http://example.org/cartoons#dumberThan",
object: db.v("s")
}
}, function(err, turtle) {
// turtle is " .\n"
});
```
It also supported by the `searchStream` method.
## Changes
[CHANGELOG.md](https://github.com/levelgraph/levelgraph-n3/blob/master/CHANGELOG.md)
**including migration info for breaking changes**
## Contributing to LevelGraph-N3
* Check out the latest master to make sure the feature hasn't been
implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't
requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests for it. This is important so I don't break it
in a future version unintentionally.
* Please try not to mess with the Makefile and package.json. If you
want to have your own version, or is otherwise necessary, that is
fine, but please isolate to its own commit so I can cherry-pick around
it.
## LICENSE - "MIT License"
Copyright (c) 2013-2015 Matteo Collina (http://matteocollina.com)
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.