Skip to content

Commit d245c8f

Browse files
committed
Change README
1 parent c3a8e6e commit d245c8f

File tree

4 files changed

+26
-77
lines changed

4 files changed

+26
-77
lines changed

.mailmap

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
Thomas Tanon <thomas@pellissier-tanon.fr> <thomaspt@hotmail.fr> <Tpt@users.noreply.github.com>
2-
Thomas Tanon <thomas@pellissier-tanon.fr>
3-
Thomas Tanon <thomas.pellissier-tanon@helsing.ai>
1+
Tobias Schwarzinger <tobias.schwarzinger@tuwien.ac.at>

README.md

Lines changed: 24 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,26 @@
1-
# Oxigraph
1+
# GraphFusion
22

3-
[![Latest Version](https://img.shields.io/crates/v/oxigraph.svg)](https://crates.io/crates/oxigraph)
4-
[![Released API docs](https://docs.rs/oxigraph/badge.svg)](https://docs.rs/oxigraph)
5-
[![PyPI](https://img.shields.io/pypi/v/pyoxigraph)](https://pypi.org/project/pyoxigraph/)
6-
[![npm](https://img.shields.io/npm/v/oxigraph)](https://www.npmjs.com/package/oxigraph)
7-
[![tests status](https://github.com/oxigraph/oxigraph/actions/workflows/tests.yml/badge.svg)](https://github.com/oxigraph/oxigraph/actions)
8-
[![artifacts status](https://github.com/oxigraph/oxigraph/actions/workflows/artifacts.yml/badge.svg)](https://github.com/oxigraph/oxigraph/actions)
9-
[![dependency status](https://deps.rs/repo/github/oxigraph/oxigraph/status.svg)](https://deps.rs/repo/github/oxigraph/oxigraph)
10-
[![Gitter](https://badges.gitter.im/oxigraph/community.svg)](https://gitter.im/oxigraph/community)
11-
[![Twitter URL](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2Foxigraph)](https://twitter.com/oxigraph)
3+
GraphFusion is a graph database implementing the [SPARQL](https://www.w3.org/TR/sparql11-overview/) standard.
124

13-
Oxigraph is a graph database implementing the [SPARQL](https://www.w3.org/TR/sparql11-overview/) standard.
5+
The query engine of GraphFusion is based on the [Apache Arrow](https://arrow.apache.org/) columnar format and
6+
[Apache DataFusion](https://datafusion.apache.org/), an extensible query engine based on Arrow.
147

15-
Its goal is to provide a compliant, safe, and fast graph database based on the [RocksDB](https://rocksdb.org/) key-value store.
16-
It is written in Rust.
17-
It also provides a set of utility functions for reading, writing, and processing RDF files.
8+
## Getting Started
189

19-
Oxigraph is in heavy development and SPARQL query evaluation has not been optimized yet.
20-
The development roadmap is using [GitHub milestones](https://github.com/oxigraph/oxigraph/milestones?direction=desc&sort=completeness&state=open).
21-
Oxigraph internal design [is described on the wiki](https://github.com/oxigraph/oxigraph/wiki/Architecture).
22-
23-
Oxigraph implements the following specifications:
24-
25-
- [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/).
26-
- [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.
27-
- [SPARQL Query Results XML Format](https://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/).
28-
29-
It is split into multiple parts:
30-
31-
- [The database written as a Rust library](./lib/oxigraph). Its source code is in the `lib` directory.
32-
[![Latest Version](https://img.shields.io/crates/v/oxigraph.svg)](https://crates.io/crates/oxigraph)
33-
[![Released API docs](https://docs.rs/oxigraph/badge.svg)](https://docs.rs/oxigraph)
34-
- [`pyoxigraph` that exposes Oxigraph to the Python world](./python). Its source code is in the `python` directory. [![PyPI](https://img.shields.io/pypi/v/pyoxigraph)](https://pypi.org/project/pyoxigraph/)
35-
- [JavaScript bindings for Oxigraph](./js). WebAssembly is used to package Oxigraph into a NodeJS compatible NPM package. Its source code is in the `js` directory.
36-
[![npm](https://img.shields.io/npm/v/oxigraph)](https://www.npmjs.com/package/oxigraph)
37-
- [Oxigraph binary](./cli) that provides a standalone command-line tool allowing to manipulate RDF data and spawn a a web server implementing the [SPARQL 1.1 Protocol](https://www.w3.org/TR/sparql11-protocol/) and the [SPARQL 1.1 Graph Store Protocol](https://www.w3.org/TR/sparql11-http-rdf-update/). Its source code is in the `cli` directory.
38-
Note that it was previously named [Oxigraph server](https://crates.io/crates/oxigraph-server).
39-
[![Latest Version](https://img.shields.io/crates/v/oxigraph-cli.svg)](https://crates.io/crates/oxigraph-cli)
40-
41-
Also, some parts of Oxigraph are available as standalone Rust crates:
42-
* [`oxrdf`](./lib/oxrdf), datastructures encoding RDF basic concepts (the [`oxigraph::model`](crate::model) module).
43-
* [`oxrdfio`](./lib/oxrdfio), a unified parser and serializer API for RDF formats (the [`oxigraph::io`](crate::io) module). It itself relies on:
44-
* [`oxttl`](./lib/oxttl), N-Triple, N-Quad, Turtle, TriG and N3 parsing and serialization.
45-
* [`oxrdfxml`](./lib/oxrdfxml), RDF/XML parsing and serialization.
46-
* [`spareval`](./lib/spareval), a SPARQL evaluator.
47-
* [`spargebra`](./lib/spargebra), a SPARQL parser.
48-
* [`sparesults`](./lib/sparesults), parsers and serializers for SPARQL result formats.
49-
* [`sparopt`](./lib/sparopt), a SPARQL optimizer.
50-
* [`oxsdatatypes`](./lib/oxsdatatypes), an implementation of some XML Schema datatypes.
51-
52-
The library layers in Oxigraph. The elements above depend on the elements below:
53-
![Oxigraph libraries architecture diagram](./docs/arch-diagram.svg)
54-
55-
A preliminary benchmark [is provided](bench/README.md). There is also [a document describing Oxigraph technical architecture](https://github.com/oxigraph/oxigraph/wiki/Architecture).
56-
57-
When cloning this codebase, don't forget to clone the submodules using
58-
`git clone --recursive https://github.com/oxigraph/oxigraph.git` to clone the repository including submodules or
59-
`git submodule update --init` to add the submodules to the already cloned repository.
10+
You can use `cargo` to interact with the codebase or use [Just](https://github.com/casey/just) to run the pre-defined
11+
commands, also used for continuous integration builds.
6012

13+
```bash
14+
git clone --recursive https://github.com/tobixdev/graphfusion.git # Clone Repository
15+
git submodule update --init # Initialize submodules
16+
just check # Run checks
17+
```
6118

6219
## Help
6320

64-
Feel free to use [GitHub discussions](https://github.com/oxigraph/oxigraph/discussions) or [the Gitter chat](https://gitter.im/oxigraph/community) to ask questions or talk about Oxigraph.
65-
[Bug reports](https://github.com/oxigraph/oxigraph/issues) are also very welcome.
66-
67-
If you need advanced support or are willing to pay to get some extra features, feel free to reach out to [Tpt](https://github.com/Tpt/).
68-
21+
Feel free to use [GitHub discussions](https://github.com/tobixdev/graphfusion/discussions) to ask questions or talk
22+
about GraphFusion.
23+
[Bug reports](https://github.com/tobixdev/graphfusion/issues) are also very welcome.
6924

7025
## License
7126

@@ -78,19 +33,15 @@ This project is licensed under either of
7833

7934
at your option.
8035

81-
### Contribution
82-
83-
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Oxigraph by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
84-
36+
## Contributing
8537

86-
## Sponsors
38+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in GraphFusion by you, as
39+
defined in the Apache-2.0 license, shall be dually licensed as above, without any additional terms or conditions.
8740

88-
* [Zazuko](https://zazuko.com/), a knowledge graph consulting company.
89-
* [RelationLabs](https://relationlabs.ai/) that is building [Relation-Graph](https://github.com/relationlabs/Relation-Graph), a SPARQL database module for the [Substrate blockchain platform](https://substrate.io/) based on Oxigraph.
90-
* [Field 33](https://field33.com) that was building [an ontology management platform](https://plow.pm/).
91-
* [Magnus Bakken](https://github.com/magbak) who is building [Data Treehouse](https://www.data-treehouse.com/), a time-series + RDF datalake platform, and [chrontext](https://github.com/magbak/chrontext), a SPARQL query endpoint on top of joint RDF and time series databases.
92-
* [DeciSym.AI](https://www.decisym.ai/) a cyber security consulting company providing RDF-based software.
93-
* [ACE IoT Solutions](https://aceiotsolutions.com/), a building IOT platform.
94-
* [Albin Larsson](https://byabbe.se/) who is building [GovDirectory](https://www.govdirectory.org/), a directory of public agencies based on Wikidata.
41+
## Acknowledgements
9542

96-
And [others](https://github.com/sponsors/Tpt). Many thanks to them!
43+
The project started as a fork from [Oxigraph](https://github.com/oxigraph/oxigraph), a graph database written in Rust
44+
with a custom SPARQL query engine.
45+
While large portions of the codebase have been written from scratch, there is still code from Oxigraph in this
46+
repository.
47+
GraphFusion would not exist without Oxigraph.

cli/src/main.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -757,6 +757,7 @@ fn evaluate_sparql_query(
757757

758758
let results = store
759759
.query_opt(query, default_query_options())
760+
.await
760761
.map_err(internal_server_error)?;
761762
match results {
762763
QueryResults::Solutions(solutions) => {

server

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)