A SHACL validator capable of planning the traversal and execution of the validation of a shape schema to detect violations early.
Project description
We present Trav-SHACL, a SHACL engine capable of planning the traversal and execution of a shape schema in a way that invalid entities are detected early and needless validations are minimized. Trav-SHACL reorders the shapes in a shape schema for efficient validation and rewrites target and constraint queries for fast detection of invalid entities. The shape schema is validated against an RDF graph accessible via a SPARQL endpoint.
How to run Trav-SHACL?
If you are looking for examples or want to reproduce the results reported in our WWW '21 paper, checkout the eval-www2021 branch.
Note: The current version of Trav-SHACL does not produce a validation report that complies with the SHACL specification. We will add this feature in the future.
Prerequisites
The following guides assume:
- Your shape schema is placed in
./shapes
and is specified inJSON
(see theeval-www2021
branch for an example) - There is a SPARQL endpoint running that you can connect to, in this example it is
http://localhost:14000/sparql
- The endpoint is running in Docker
- It is connected to the Docker network
semantic-web
- Its name is
endpoint1
- The port
8890
of the Docker container is mapped to port14000
of the host
Parameters
-d schemaDir
(necessary) - path to the directory containing the shape filesendpoint
(necessary) - URL of the endpoint the shape schema will be validated againstgraphTraversal
(necessary) - defines the graph traversal algorithm to be used, is one of[BFS, DFS]
outputDir
(necessary) - directory to be used for storing the result files, has to end on/
--heuristics
(necessary) - used to determine the seed shapeTARGET
if shapes with a target definition should be prioritized, otherwise omit- prioritize in- or outdegree of shapes, one of
[IN, OUT]
or to be omitted - prioritize shapes based on their number of constraints, one of
[BIG, SMALL]
or to be omitted
--selective
(optional) - use more selective queries for constraint queries--outputs
(optional) - creates one file each for violated and validated targets, otherwise only statistics and traces will be stored-m
(optional) - maximum number of entities in FILTER or VALUES clause of a SPARQL query, default: 256-j
/--json
(optional) - indicates that the SHACL shape schema is expressed in JSON
Run with Docker
In order to connect to the SPARQL endpoint, it must be accessible from within the Docker container.
There shouldn't be anything to configure if you use a public endpoint like DBpedia or Wikidata.
However, if you run your own dockerized SPARQL endpoints, make sure that the endpoint and the Trav-SHACL container are connected to the same Docker network, in this example it is called semantic-web
.
# Preparation
docker build -t travshacl .
docker run --name trav-shacl -v $(pwd)/shapes:/shapes -v $(pwd)/results:/results --network=semantic-web -d travshacl
# Run the Validation
docker exec -it trav-shacl bash -c "python3 main.py -d /shapes http://endpoint1:8890/sparql /results/ DFS --heuristics TARGET IN BIG --orderby --selective --outputs --json"
Run with Python3
pip3 install -r requirements.txt
python3 main.py -d ./shapes http://localhost:14000/sparql ./results/ DFS --heuristics TARGET IN BIG --orderby --selective --outputs --json
How to run the Test Suite?
In order to run the test suite, you need to install the production and development dependencies.
pip3 install -r requirements.txt -r requirements-dev.txt
Afterwards, start the Docker container with the test data.
docker-compose -f tests/docker-compose.yml up -d
Finally, you can run the tests by executing the following command.
pytest
Publications
- Mónica Figuera, Philipp D. Rohde, Maria-Esther Vidal. Trav-SHACL: Efficiently Validating Networks of SHACL Constraints. In Proceedings of the Web Conference 2021 (WWW '21), April 19-23, 2021, Ljubljana, Slovenia. https://doi.org/10.1145/3442381.3449877, Experiment Scripts, Preprint
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file TravSHACL-1.1.2.tar.gz
.
File metadata
- Download URL: TravSHACL-1.1.2.tar.gz
- Upload date:
- Size: 43.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b62d70dd1cf439e8587f51b4248a0ca905d4718d58ea70b89277473da56582f |
|
MD5 | d2c44297a07aa5302b211726ac394dc7 |
|
BLAKE2b-256 | 8ca1fabcf9cd94994ebbbcb94dc20aeea4347ca26e793a27c3ea311f9ec1d27d |
File details
Details for the file TravSHACL-1.1.2-py3-none-any.whl
.
File metadata
- Download URL: TravSHACL-1.1.2-py3-none-any.whl
- Upload date:
- Size: 49.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a018092cbd0c38bd40a2574aa45b6068f6ec2bf8c2b1376334e15ae0d1900d6 |
|
MD5 | c11f05caf3e7130c6ea0ef5016262a9d |
|
BLAKE2b-256 | d75796be7e89ed174becb8f4be3fe39e0bb2a5878bd7087e27ce48364b0d8740 |