Skip to content

Clarify YIELD #1157

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 4 commits into from
Jan 14, 2025
Merged

Clarify YIELD #1157

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d1e5a3e
clarify yield
JPryce-Aklundh Jan 13, 2025
1d4ec37
spelling
JPryce-Aklundh Jan 13, 2025
427b2d6
Update modules/ROOT/pages/clauses/call.adoc
JPryce-Aklundh Jan 13, 2025
25c797c
updates
JPryce-Aklundh Jan 14, 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
4 changes: 3 additions & 1 deletion modules/ROOT/pages/clauses/call.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,8 @@ CALL db.labels() YIELD *
If the procedure has deprecated return columns, those columns are also returned.

Note that `YIELD *` is only valid in standalone procedure calls.
Variables must be explicitly named in a `YIELD` clause if other clauses than `CALL` are present.
This restriction simplifies query logic and protects against issues caused by potential new columns added to a procedure.
For example, the following is not valid:

.Not allowed
Expand All @@ -204,7 +206,7 @@ RETURN count(*) AS results
====

`YIELD` can be used to filter for specific results.
This requires knowing the names of the arguments within a procedure's signature, which can either be found in the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/procedures/[Operations Manual -> Procedures] or returned by a `SHOW PROCEDURES` query.
This requires knowing the names of the arguments within a procedure's signature, which can either be found in the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/procedures/[Operations Manual -> Procedures] or in the `signature` column returned by a `SHOW PROCEDURES` query.

.Find the argument names of `db.propertyKeys`
[source, cypher]
Expand Down
Loading