graph validation Command Group¤
Validate resources in a graph.
This command group is dedicated to the management of resource validation processes. A validation process verifies, that resources in a specific graph are valid according to the node shapes in a shape catalog graph.
Note
Validation processes are identified with a random ID and can be listed with the graph validation list command. To start or cancel validation processes, use the graph validation execute and graph validation cancel command. To inspect the found violations of a validation process, use the graph validation inspect command.
graph validation execute¤
Start a new validation process.
Validation is performed on all typed resources of a data / context graph (IRI). Each resource is validated against all applicable node shapes from a selected shape catalog graph (and its sub-graphs).
Options
--shape-graph TEXT The shape catalog used for validation.
[default: https://vocab.eccenca.com/shacl/]
--id-only Return the validation process identifier
only. This is useful for piping the ID into
other commands.
--wait Wait until the process is finished. When
using this option without the `--id-only`
flag, it will enable a progress bar and a
summary view.
--polling-interval INTEGER RANGE
How many seconds to wait between status
polls. Status polls are cheap, so a higher
polling interval is most likely not needed.
[default: 1; x>=1]
graph validation list¤
List running and finished validation processes.
This command provides a filterable table or identifier list of validation processes. The command operates on the process summary and provides some statistics.
Note
Detailed information on the found violations can be listed with the graph validation inspect command.
Options
--filter <TEXT TEXT>... Filter validation processes by one of the following
filter names and a corresponding value: status,
context-graph, shape-graph, more-resources-than,
more-violations-than, more-violated-resources-than.
--id-only List validation process identifier only. This is
useful for piping the IDs into other commands.
--raw Outputs raw JSON of the validation list.
graph validation inspect¤
List and inspect errors found with a validation process.
This command provides detailed information on the found violations of a validation process.
Use the --filter option to limit the output based on different criteria such as constraint name (constraint), origin node shape of the rule (node-shape), or the validated resource (resource).
Note
Validation processes IDs can be listed with the graph validation list command, or by utilizing the tab completion of this command.
Options
--filter <TEXT TEXT>... Filter violations by one of the following filter
names and a corresponding value: constraint,
severity, resource, node-shape, property-shape.
--id-only Return violated resource identifier only. This is
useful for piping the ID into other commands.
--summary Outputs the summary of the graph validation instead
of the violations list (not filterable).
--raw Outputs raw JSON of the validation result.
graph validation cancel¤
Cancel a running validation process.
Note
In order to get the process IDs of all currently running validation processes, use the graph validation list command with the option --filter status running, or utilize the tab completion of this command.