From f3d6da2e8389350f68f925a3a820873997dc57e3 Mon Sep 17 00:00:00 2001 From: Martin Klotz Date: Sun, 15 Dec 2024 23:55:36 +0100 Subject: [PATCH] update docs --- docs/graph_ops/link.md | 8 ++++++++ docs/graph_ops/map.md | 15 +++++++++++++++ 2 files changed, 23 insertions(+) diff --git a/docs/graph_ops/link.md b/docs/graph_ops/link.md index ecbb3424..6f75641f 100644 --- a/docs/graph_ops/link.md +++ b/docs/graph_ops/link.md @@ -17,6 +17,10 @@ The 1-based index selecting the value providing node in the AQL source query. Contains one or multiple 1-based indexes, from which (in order of mentioning) the value for mapping source and target will be concatenated. +### source_to_edge + +This 1-based index list can be used to copy the given annotations from the source query to the edge that is to be created. + ### target_query The AQL query to find all target node annotations. @@ -29,6 +33,10 @@ The 1-based index selecting the value providing node in the AQL target query. Contains one or multiple 1-based indexes, from which (in order of mentioning) the value for mapping source and target will be concatenated. +### target_to_edge + +This 1-based index list can be used to copy the given annotations from the target query to the edge that is to be created. + ### component The edge component to be built. diff --git a/docs/graph_ops/map.md b/docs/graph_ops/map.md index 26f39a1a..d06d47f2 100644 --- a/docs/graph_ops/map.md +++ b/docs/graph_ops/map.md @@ -100,3 +100,18 @@ finish! The path of the TOML file containing an array of mapping rules. +### debug + +If you wish for detailled output about the match count of each rule, +set this to `true`. Default is `false`, so no output. + +Example: +```toml +[[graph_op]] +action = "map" + +[graph_op.config] +rule_file = "mapping-rules.toml" +debug = true +``` +