Skip to content

Params note #785

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 2 commits into from
Aug 8, 2025
Merged

Params note #785

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d31129
add note abpout quotations around param values
AlexicaWright Aug 8, 2025
95e26ce
moved note
AlexicaWright Aug 8, 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 modules/ROOT/pages/query/operations.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ This process is much like using the `:param` command, as described in the follow

==== `:param` command

The `+:param name => 'Example'+` command defines a parameter named `name`, which will be sent along with your queries. +
The `+:param name => 'Example'+` command defines a parameter named `name`, which will be sent along with your queries.
The right hand side of `=>` is sent to the server and evaluated as Cypher with an implicit `RETURN` in front.
This gives better type safety since some types (especially numbers) in JavaScript are hard to match with Neo4j's type system.
To see the list of all currently set query parameters and their values, use the `:params` command.
Expand Down Expand Up @@ -268,6 +268,13 @@ You need to run the `:param` command separately from the `MATCH` query.

=====

[NOTE]
====
Any parameter value enclosed in single (') or double (") quotes is considered a `string`.
If the intention is to use _JSON_ objects as a parameter, you may use the APOC function `apoc.convert.fromJsonList` to achieve this.
See link:{neo4j-docs-base-uri}/apoc/current/overview/apoc.convert/apoc.convert.fromJsonList/[APOC Core documentation -> Procedures and functions] for more information.
====

[[clear-params]]
=== Clear parameters

Expand Down