Tpt
4 years ago
parent
cc185931e5
commit
9884decf52
@ -0,0 +1,77 @@ |
|||||||
|
Oxigraph |
||||||
|
======== |
||||||
|
|
||||||
|
[](https://crates.io/crates/oxigraph) |
||||||
|
[](https://docs.rs/oxigraph) |
||||||
|
[](https://crates.io/crates/oxigraph) |
||||||
|
[](https://github.com/oxigraph/oxigraph/actions) |
||||||
|
[](https://gitter.im/oxigraph/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) |
||||||
|
|
||||||
|
Oxigraph is a graph database library implementing the [SPARQL](https://www.w3.org/TR/sparql11-overview/) standard. |
||||||
|
|
||||||
|
Its goal is to provide a compliant, safe and fast graph database. |
||||||
|
It also provides a set of utility functions for reading, writing, and processing RDF files. |
||||||
|
|
||||||
|
It currently provides three store implementations providing [SPARQL](https://www.w3.org/TR/sparql11-overview/) capability: |
||||||
|
* `MemoryStore`: a simple in memory implementation. |
||||||
|
* `RocksDbStore`: a file system implementation based on the [RocksDB](https://rocksdb.org/) key-value store. |
||||||
|
It requires the `"rocksdb"` feature to be activated. |
||||||
|
The [clang](https://clang.llvm.org/) compiler needs to be installed to compile RocksDB. |
||||||
|
* `SledStore`: another file system implementation based on the [Sled](https://sled.rs/) key-value store. |
||||||
|
It requires the `"sled"` feature to be activated. |
||||||
|
Sled is much faster to build than RockDB and does not require a C++ compiler. |
||||||
|
However, Sled is still in development, less tested and data load seems much slower than RocksDB. |
||||||
|
|
||||||
|
Oxigraph is in heavy development and SPARQL query evaluation has not been optimized yet. |
||||||
|
|
||||||
|
The disabled by default `"sophia"` feature provides [`sophia_api`](https://docs.rs/sophia_api/) traits implementation on Oxigraph terms and stores. |
||||||
|
|
||||||
|
Oxigraph also provides [a standalone HTTP server](https://crates.io/crates/oxigraph_server) and [a Python library](https://oxigraph.org/pyoxigraph/) based on this library. |
||||||
|
|
||||||
|
|
||||||
|
Oxigraph implements the following specifications: |
||||||
|
* [SPARQL 1.1 Query](https://www.w3.org/TR/sparql11-query/), [SPARQL 1.1 Update](https://www.w3.org/TR/sparql11-update/), and [SPARQL 1.1 Federated Query](https://www.w3.org/TR/sparql11-federated-query/). |
||||||
|
* [Turtle](https://www.w3.org/TR/turtle/), [TriG](https://www.w3.org/TR/trig/), [N-Triples](https://www.w3.org/TR/n-triples/), [N-Quads](https://www.w3.org/TR/n-quads/), and [RDF XML](https://www.w3.org/TR/rdf-syntax-grammar/) RDF serialization formats for both data ingestion and retrieval using the [Rio library](https://github.com/oxigraph/rio). |
||||||
|
* [SPARQL Query Results XML Format](http://www.w3.org/TR/rdf-sparql-XMLres/), [SPARQL 1.1 Query Results JSON Format](https://www.w3.org/TR/sparql11-results-json/) and [SPARQL 1.1 Query Results CSV and TSV Formats](https://www.w3.org/TR/sparql11-results-csv-tsv/). |
||||||
|
|
||||||
|
A preliminary benchmark [is provided](../bench/README.md). |
||||||
|
|
||||||
|
Usage example with the `MemoryStore`: |
||||||
|
|
||||||
|
```rust |
||||||
|
use oxigraph::MemoryStore; |
||||||
|
use oxigraph::model::*; |
||||||
|
use oxigraph::sparql::QueryResults; |
||||||
|
|
||||||
|
let store = MemoryStore::new(); |
||||||
|
|
||||||
|
// insertion |
||||||
|
let ex = NamedNode::new("http://example.com")?; |
||||||
|
let quad = Quad::new(ex.clone(), ex.clone(), ex.clone(), None); |
||||||
|
store.insert(quad.clone()); |
||||||
|
|
||||||
|
// quad filter |
||||||
|
let results: Vec<Quad> = store.quads_for_pattern(Some(ex.as_ref().into()), None, None, None).collect(); |
||||||
|
assert_eq!(vec![quad], results); |
||||||
|
|
||||||
|
// SPARQL query |
||||||
|
if let QueryResults::Solutions(mut solutions) = store.query("SELECT ?s WHERE { ?s ?p ?o }")? { |
||||||
|
assert_eq!(solutions.next().unwrap()?.get("s"), Some(&ex.into())); |
||||||
|
} |
||||||
|
``` |
||||||
|
|
||||||
|
## License |
||||||
|
|
||||||
|
This project is licensed under either of |
||||||
|
|
||||||
|
* Apache License, Version 2.0, ([LICENSE-APACHE](../LICENSE-APACHE) or |
||||||
|
http://www.apache.org/licenses/LICENSE-2.0) |
||||||
|
* MIT license ([LICENSE-MIT](../LICENSE-MIT) or |
||||||
|
http://opensource.org/licenses/MIT) |
||||||
|
|
||||||
|
at your option. |
||||||
|
|
||||||
|
|
||||||
|
### Contribution |
||||||
|
|
||||||
|
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Futures by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. |
||||||
@ -0,0 +1,104 @@ |
|||||||
|
Oxigraph Server |
||||||
|
=============== |
||||||
|
|
||||||
|
[](https://crates.io/crates/oxigraph_server) |
||||||
|
[](https://crates.io/crates/oxigraph_server) |
||||||
|
[](https://hub.docker.com/repository/docker/oxigraph/oxigraph) |
||||||
|
[](https://hub.docker.com/repository/docker/oxigraph/oxigraph) |
||||||
|
[](https://hub.docker.com/repository/docker/oxigraph/oxigraph) |
||||||
|
[](https://github.com/oxigraph/oxigraph/actions) |
||||||
|
[](https://gitter.im/oxigraph/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) |
||||||
|
|
||||||
|
Oxigraph Server is a standalone HTTP server providing a graph database implementing the [SPARQL](https://www.w3.org/TR/sparql11-overview/) standard. |
||||||
|
|
||||||
|
Its goal is to provide a compliant, safe, and fast graph database based on the [RocksDB](https://rocksdb.org/) key-value stores. |
||||||
|
It is written in Rust. |
||||||
|
It also provides a set of utility functions for reading, writing, and processing RDF files. |
||||||
|
|
||||||
|
Oxigraph is in heavy development and SPARQL query evaluation has not been optimized yet. |
||||||
|
|
||||||
|
It is also usable as [a Rust library](https://crates.io/crates/oxigraph) and as [a Python library](https://oxigraph.org/pyoxigraph/). |
||||||
|
|
||||||
|
Oxigraph implements the following specifications: |
||||||
|
* [SPARQL 1.1 Query](https://www.w3.org/TR/sparql11-query/), [SPARQL 1.1 Update](https://www.w3.org/TR/sparql11-update/), and [SPARQL 1.1 Federated Query](https://www.w3.org/TR/sparql11-federated-query/). |
||||||
|
* [Turtle](https://www.w3.org/TR/turtle/), [TriG](https://www.w3.org/TR/trig/), [N-Triples](https://www.w3.org/TR/n-triples/), [N-Quads](https://www.w3.org/TR/n-quads/), and [RDF XML](https://www.w3.org/TR/rdf-syntax-grammar/) RDF serialization formats for both data ingestion and retrieval using the [Rio library](https://github.com/oxigraph/rio). |
||||||
|
* [SPARQL Query Results XML Format](http://www.w3.org/TR/rdf-sparql-XMLres/), [SPARQL 1.1 Query Results JSON Format](https://www.w3.org/TR/sparql11-results-json/) and [SPARQL 1.1 Query Results CSV and TSV Formats](https://www.w3.org/TR/sparql11-results-csv-tsv/). |
||||||
|
* [SPARQL 1.1 Protocol](https://www.w3.org/TR/sparql11-protocol/#query-operation) and [SPARQL 1.1 Graph Store HTTP Protocol](https://www.w3.org/TR/sparql11-http-rdf-update/). |
||||||
|
|
||||||
|
A preliminary benchmark [is provided](../bench/README.md). |
||||||
|
|
||||||
|
## Installation |
||||||
|
|
||||||
|
You need to have [a recent stable version of Rust and Cargo installed](https://www.rust-lang.org/tools/install). You also need [clang](https://clang.llvm.org/) to build RocksDB. |
||||||
|
|
||||||
|
To download, build and install the latest released version run `cargo install oxigraph_server`. |
||||||
|
There is no need to clone the git repository. |
||||||
|
|
||||||
|
To compile the server from source, clone this git repository, and execute `cargo build --release` in the `server` directory to compile the full server after having downloaded its dependencies. |
||||||
|
It will create a fat binary in `target/release/oxigraph_server`. |
||||||
|
|
||||||
|
## Usage |
||||||
|
|
||||||
|
Run `oxigraph_server -f my_data_storage_directory` to start the server where `my_data_storage_directory` is the directory where you want Oxigraph data to be stored in. It listens by default on `localhost:7878`. |
||||||
|
|
||||||
|
The server provides an HTML UI with a form to execute SPARQL requests. |
||||||
|
|
||||||
|
It provides the following REST actions: |
||||||
|
* `/query` allows to evaluate SPARQL queries against the server repository following the [SPARQL 1.1 Protocol](https://www.w3.org/TR/sparql11-protocol/#query-operation). |
||||||
|
For example `curl -X POST -H 'Content-Type:application/sparql-query' --data 'SELECT * WHERE { ?s ?p ?o } LIMIT 10' http://localhost:7878/query`. |
||||||
|
This action supports content negotiation and could return [Turtle](https://www.w3.org/TR/turtle/), [N-Triples](https://www.w3.org/TR/n-triples/), [RDF XML](https://www.w3.org/TR/rdf-syntax-grammar/), [SPARQL Query Results XML Format](http://www.w3.org/TR/rdf-sparql-XMLres/) and [SPARQL Query Results JSON Format](https://www.w3.org/TR/sparql11-results-json/). |
||||||
|
* `/update` allows to execute SPARQL updates against the server repository following the [SPARQL 1.1 Protocol](https://www.w3.org/TR/sparql11-protocol/#update-operation). |
||||||
|
For example `curl -X POST -H 'Content-Type: application/sparql-update' --data 'DELETE WHERE { <http://example.com/s> ?p ?o }' http://localhost:7878/update`. |
||||||
|
* `/store` allows to retrieve and change the server content using the [SPARQL 1.1 Graph Store HTTP Protocol](https://www.w3.org/TR/sparql11-http-rdf-update/). |
||||||
|
For example `curl -f -X POST -H 'Content-Type:application/n-triples' --data-binary "@MY_FILE.nt" http://localhost:7878/store?graph=http://example.com/g` will add the N-Triples file MY_FILE.nt to the server dataset inside of the `http://example.com/g` named graph. |
||||||
|
[Turtle](https://www.w3.org/TR/turtle/), [N-Triples](https://www.w3.org/TR/n-triples/) and [RDF XML](https://www.w3.org/TR/rdf-syntax-grammar/) are supported. |
||||||
|
It is also possible to `POST`, `PUT` and `GET` the complete RDF dataset on the server using RDF dataset formats ([TriG](https://www.w3.org/TR/trig/) and [N-Quads](https://www.w3.org/TR/n-quads/)) against the `/store` endpoint. |
||||||
|
For example `curl -f -X POST -H 'Content-Type:application/n-quads' --data-binary "@MY_FILE.nq" http://localhost:7878/store` will add the N-Quads file MY_FILE.nq to the server dataset. |
||||||
|
|
||||||
|
Use `oxigraph_server --help` to see the possible options when starting the server. |
||||||
|
|
||||||
|
## Using a Docker image |
||||||
|
|
||||||
|
### Display the help menu |
||||||
|
```sh |
||||||
|
docker run --rm oxigraph/oxigraph --help |
||||||
|
``` |
||||||
|
|
||||||
|
### Run the Web server |
||||||
|
Expose the server on port `7878` of the host machine, and save data on the local `./data` folder |
||||||
|
```sh |
||||||
|
docker run --init --rm -v $PWD/data:/data -p 7878:7878 oxigraph/oxigraph -b 0.0.0.0:7878 -f /data |
||||||
|
``` |
||||||
|
|
||||||
|
You can then access it from your machine on port `7878`: |
||||||
|
```sh |
||||||
|
# Open the GUI in a browser |
||||||
|
firefox http://localhost:7878 |
||||||
|
|
||||||
|
# Post some data |
||||||
|
curl http://localhost:7878/store?default -H 'Content-Type: text/turtle' -d@./data.ttl |
||||||
|
|
||||||
|
# Make a query |
||||||
|
curl -X POST -H 'Accept: application/sparql-results+json' -H 'Content-Type: application/sparql-query' --data 'SELECT * WHERE { ?s ?p ?o } LIMIT 10' http://localhost:7878/query |
||||||
|
|
||||||
|
# Make an UPDATE |
||||||
|
curl -X POST -H 'Content-Type: application/sparql-update' --data 'DELETE WHERE { <http://example.com/s> ?p ?o }' http://localhost:7878/update |
||||||
|
``` |
||||||
|
|
||||||
|
You could easily build your own Docker image by running `docker build -t oxigraph server -f server/Dockerfile .` from the root directory. |
||||||
|
|
||||||
|
## License |
||||||
|
|
||||||
|
This project is licensed under either of |
||||||
|
|
||||||
|
* Apache License, Version 2.0, ([LICENSE-APACHE](../LICENSE-APACHE) or |
||||||
|
http://www.apache.org/licenses/LICENSE-2.0) |
||||||
|
* MIT license ([LICENSE-MIT](../LICENSE-MIT) or |
||||||
|
http://opensource.org/licenses/MIT) |
||||||
|
|
||||||
|
at your option. |
||||||
|
|
||||||
|
|
||||||
|
### Contribution |
||||||
|
|
||||||
|
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Futures by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. |
||||||
@ -0,0 +1,81 @@ |
|||||||
|
Oxigraph Wikibase |
||||||
|
================= |
||||||
|
|
||||||
|
[](https://crates.io/crates/oxigraph_wikibase) |
||||||
|
[](https://crates.io/crates/oxigraph_wikibase) |
||||||
|
[](https://hub.docker.com/repository/docker/oxigraph/oxigraph-wikibase) |
||||||
|
[](https://hub.docker.com/repository/docker/oxigraph/oxigraph-wikibase) |
||||||
|
[](https://hub.docker.com/repository/docker/oxigraph/oxigraph-wikibase) |
||||||
|
[](https://github.com/oxigraph/oxigraph/actions) |
||||||
|
[](https://gitter.im/oxigraph/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) |
||||||
|
|
||||||
|
Oxigraph Wikibase is a [SPARQL](https://www.w3.org/TR/sparql11-overview/) web server able to synchronize with a [Wikibase instance](https://wikiba.se/). |
||||||
|
It is based on [Oxigraph](https://crates.io/crates/oxigraph). |
||||||
|
|
||||||
|
Oxigraph and Oxigraph Wikibase are in heavy development and not been optimized yet. |
||||||
|
|
||||||
|
## Installation |
||||||
|
|
||||||
|
You need to have [a recent stable version of Rust and Cargo installed](https://www.rust-lang.org/tools/install). You also need [clang](https://clang.llvm.org/) to build RocksDB. |
||||||
|
|
||||||
|
To download, build and install the latest released version run `cargo install oxigraph_wikibase`. |
||||||
|
There is no need to clone the git repository. |
||||||
|
|
||||||
|
To compile the server from source, clone this git repository, and execute `cargo build --release` in the `wikibase` directory to compile the full server after having downloaded its dependencies. |
||||||
|
It will create a fat binary in `target/release/oxigraph_wikibase`. |
||||||
|
|
||||||
|
## Usage |
||||||
|
|
||||||
|
To start a server that is synchronized with [test.wikidata.org](https://test.wikidata.org) you should run: |
||||||
|
```bash |
||||||
|
./oxigraph_wikibase --mediawiki-api https://test.wikidata.org/w/api.php --mediawiki-base-url https://test.wikidata.org/wiki/ --namespaces 0,120 --file test.wikidata |
||||||
|
``` |
||||||
|
|
||||||
|
It creates a SPARQL endpoint listening to `localhost:7878/query` that could be queried just like Blazegraph. |
||||||
|
|
||||||
|
The configuration parameters are: |
||||||
|
* `mediawiki_api` URL of the MediaWiki API to use |
||||||
|
* `mediawiki_base_url` Base URL of MediaWiki pages like `https://test.wikidata.org/wiki/` for test.wikidata.org or `http://localhost/w/index.php?title=` for "vanilla" installations. |
||||||
|
* `namespaces` The ids of the Wikibase namespaces to synchronize with, separated by `,`. |
||||||
|
* `file` Path of where Oxigraph should store its data. |
||||||
|
|
||||||
|
|
||||||
|
You can then access it from your machine on port `7878`. No GUI is provided. |
||||||
|
```sh |
||||||
|
# Make a query |
||||||
|
curl -X POST -H 'Accept: application/sparql-results+json' -H 'Content-Type: application/sparql-query' --data 'SELECT * WHERE { ?s ?p ?o } LIMIT 10' http://localhost:7878/query |
||||||
|
``` |
||||||
|
## Using a Docker image |
||||||
|
|
||||||
|
### Display the help menu |
||||||
|
```sh |
||||||
|
docker run --rm oxigraph/oxigraph-wikibase --help |
||||||
|
``` |
||||||
|
|
||||||
|
### Run the Web server |
||||||
|
Expose the server on port `7878` of the host machine, and save data on the local `./data` folder |
||||||
|
```sh |
||||||
|
docker run --init --rm -v $PWD/wikibase_data:/wikibase_data -p 7878:7878 oxigraph/oxigraph-wikibase -b 0.0.0.0:7878 -f /wikibase_data --mediawiki-api http://some.wikibase.instance/w/api.php --mediawiki-base-url http://some.wikibase.instance/wiki/ |
||||||
|
``` |
||||||
|
|
||||||
|
Warning: the Wikibase instance needs to be accessible from within the container. |
||||||
|
The clean way to do that could be to have both your wikibase and oxigraph_wikibase in the same [`docker-compose.yml`](https://docs.docker.com/compose/). |
||||||
|
|
||||||
|
You could easily build your own Docker image by running `docker build -t oxigraph-wikibase -f wikibase/Dockerfile .` from the root directory. |
||||||
|
|
||||||
|
|
||||||
|
## License |
||||||
|
|
||||||
|
This project is licensed under either of |
||||||
|
|
||||||
|
* Apache License, Version 2.0, ([LICENSE-APACHE](../LICENSE-APACHE) or |
||||||
|
http://www.apache.org/licenses/LICENSE-2.0) |
||||||
|
* MIT license ([LICENSE-MIT](../LICENSE-MIT) or |
||||||
|
http://opensource.org/licenses/MIT) |
||||||
|
|
||||||
|
at your option. |
||||||
|
|
||||||
|
|
||||||
|
### Contribution |
||||||
|
|
||||||
|
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Futures by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. |
||||||
Loading…
Reference in new issue