Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinKl committed Dec 15, 2024
1 parent 42b02b1 commit f3d6da2
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/graph_ops/link.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down
15 changes: 15 additions & 0 deletions docs/graph_ops/map.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

0 comments on commit f3d6da2

Please sign in to comment.