Skip to content

Added migration guide about the the queryDirection changes #208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions modules/ROOT/pages/migration/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -525,3 +525,14 @@ The `directed` argument was used to change the query direction of the relationsh

The `directed` argument in `@relationship` fields is deprecated and will be removed in the future.
Configure the query direction via the `queryDirection` and `direction` arguments of the `@relationship` directive instead.

=== Deprecated `@relationship.queryDirection` `_DEFAULT` and `_ONLY` options

Following the deprecation of the `directed` argument, the values accepted by the `@relationship.queryDirection` have changed:

- `DEFAULT_DIRECTED` is deprecated.
- `DEFAULT_UNDIRECTED` is deprecated.
- `DIRECTED_ONLY` is renamed to `DIRECTED`.
- `UNDIRECTED_ONLY` is renamed to `UNDIRECTED`.

A warning is raised if you use a deprecated value.
6 changes: 2 additions & 4 deletions modules/ROOT/pages/types/relationships.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -140,10 +140,8 @@ type Person @node {

`queryDirection` can have the following values:

* `DEFAULT_DIRECTED` (default): all queries are **directed** by default, but users may perform undirected queries.
* `DEFAULT_UNDIRECTED`: all queries are **undirected** by default, but users may perform directed queries.
* `DIRECTED_ONLY`: only directed queries can be performed on this relationship.
* `UNDIRECTED_ONLY`: only undirected queries can be performed on this relationship.
* `DIRECTED`: only directed queries can be performed on this relationship.
* `UNDIRECTED`: only undirected queries can be performed on this relationship.

== Inserting data

Expand Down
Loading