Skip to content

updating the parameters guide #56

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.

Sign up for GitHub

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 3 commits into from
Mar 27, 2025
Merged

updating the parameters guide #56

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5fbfca3
updating the parameters guide
nnecla Mar 26, 2025
12cc3fc
removing the unfinished sentence
nnecla Mar 27, 2025
511c5af
Update documentation/workspace-params.adoc
nnecla Mar 27, 2025
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
9 changes: 8 additions & 1 deletion documentation/workspace-params.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,14 @@ You can read more about parameters https://neo4j.com/docs/cypher-manual/current/

=== Setting and Managing Parameters

Parameters are set and managed in Query using the `:param` command.
Parameters can be created and managed either via the parameters sidebar or by invoking the `:param` command in a Cypher editor.

The Parameters sidebar provides dedicated UI inputs for most of the neo4j https://neo4j.com/docs/cypher-manual/current/values-and-types/property-structural-constructed/#property-types[property types].
There are a few exceptions such as the https://neo4j.com/docs/cypher-manual/current/values-and-types/spatial/#spatial-values-point-type[Point] type and the setting of https://neo4j.com/docs/cypher-manual/current/values-and-types/property-structural-constructed/#constructed-types[constructed types].
To support the setting of these types via the UI, there is also a special option of `evaluated` in the type dropdown.
This allows you to express any parameter type as you would using the right-hand part of the command syntax inlinecode:++:param pointParam => Point({x:1, y:1})++[], in this example `Point({x:1, y:1})` as the value to be evaluated.

For types that are not supported by the UI, or indeed if you prefer working with commands, the `:param` command provides the ability to set and manage parameters.
The following arguments are supported:

* inlinecode:++:param list++[] or inlinecode:++:param++[] - Lists all parameters
Expand Down