Skip to content
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

Cypher manual images refresh #1205

Closed
wants to merge 93 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
93 commits
Select commit Hold shift + click to select a range
c4de60d
Clarify CALL subquery ambiguities (#1060)
JPryce-Aklundh Oct 14, 2024
b5ccab3
Deprecate `existingDataSeedInstance` option to CREATE DATABASE (#1047)
mnd999 Oct 15, 2024
c0be0b4
Bump express from 4.21.0 to 4.21.1 in the dev-dependencies group (#1061)
dependabot[bot] Oct 15, 2024
942baab
clarify point.distance function (#1064)
JPryce-Aklundh Oct 15, 2024
42f1457
fix functions table (Logarithmic was missing) (#1065)
JPryce-Aklundh Oct 15, 2024
ab80e08
Restructure Constraints section (#1041)
JPryce-Aklundh Oct 17, 2024
1073249
Add new label to type constraints and page alias (#1066)
JPryce-Aklundh Oct 17, 2024
1085290
Fix typo and change auradb enterprise to auradb virtual dedicated clo…
JPryce-Aklundh Oct 21, 2024
1a55a02
Intro with a link to ops manual for cloud URI section (#1071)
rsill-neo4j Oct 21, 2024
6d4287c
Make Cypher Manual AuraDB Business Critical aware (#1072)
JPryce-Aklundh Oct 21, 2024
1a428e0
Fix remaining examples of CALL subqueries without variable scope clau…
JPryce-Aklundh Oct 22, 2024
5f6f6ee
Fix SHOW CONSTRAINTS table (#1075)
JPryce-Aklundh Oct 22, 2024
720b732
Aura update for parallel runtime (#1076)
JPryce-Aklundh Oct 24, 2024
1aae0d5
Document max identifier length (#1077)
JPryce-Aklundh Oct 24, 2024
ad1e5fd
Add missing curly bracket (#1079)
JPryce-Aklundh Oct 24, 2024
ea86dc9
Update MATCH page (#1080)
JPryce-Aklundh Oct 25, 2024
ac1b2fd
Small fix to MATCH (#1085)
JPryce-Aklundh Oct 30, 2024
cdec96a
Remove mentions of Neo4j 6.0 (#1086)
JPryce-Aklundh Oct 30, 2024
e594bab
Fix cos() table (#1087)
JPryce-Aklundh Oct 30, 2024
d61392b
update antora for 5.26 (#1091)
JPryce-Aklundh Oct 31, 2024
dc20574
Include statements for functions section (#1004)
rsill-neo4j Oct 31, 2024
a740be1
Document change in behaviour for db.schema.nodeTypeProperties() and d…
gem-neo4j Oct 31, 2024
e76ca0a
Adding the new functionality of property-based access control to list…
HannesSandberg Oct 31, 2024
ab342a0
Add entry in additions/removals about parameters in CREATE/ALTER DB T…
l-heemann Oct 31, 2024
6efbb2a
Fix version exact roles (#1095)
JPryce-Aklundh Oct 31, 2024
36159ae
cip-190 deprecations (#1084)
hvub Nov 5, 2024
546c4eb
Remove use of index-provider option (#1096)
emmaholmbergohlsson Nov 5, 2024
b4fc0fe
Update README to include documenting changes to language and GQL (#1100)
JPryce-Aklundh Nov 7, 2024
d30abc0
Document the deprecation of the `indexProvider` option (#1101)
l-heemann Nov 8, 2024
24f592c
Further deprecations to options in CREATE DATABASE (#1083)
mnd999 Nov 11, 2024
9f21e04
Change SHOW SETTINGS filter query example (#1103)
JPryce-Aklundh Nov 11, 2024
df29ec0
Explain return values from vector functions (#1104)
JPryce-Aklundh Nov 11, 2024
312d908
fix xref on LOAD CSV page (#1107)
JPryce-Aklundh Nov 11, 2024
dbbfb5c
Fix links to the Operations manual (#1106)
NataliaIvakina Nov 11, 2024
2d3c71b
Document old deprecation for database naming (#1105)
mnd999 Nov 14, 2024
fbbc11d
use quote in backticks rather than escape (#1111)
JPryce-Aklundh Nov 14, 2024
1abbd2c
Typo fix (#1110)
juantoser Nov 15, 2024
afeeb5a
Replace NODES ad with developer survey (#1112)
recrwplay Nov 15, 2024
d6b2f98
Dynamic labels/types (#1098)
JPryce-Aklundh Nov 19, 2024
36a4486
Fix vector config performance suggestion (#1115)
JPryce-Aklundh Nov 19, 2024
30f87f5
add complete fulltext stop words and clarify populating state (#1116)
JPryce-Aklundh Nov 25, 2024
e5de1b6
Fix failing query example (#1119)
JPryce-Aklundh Nov 25, 2024
8c0e2eb
Document the availability of graph.byelementid on standard databases …
JPryce-Aklundh Nov 26, 2024
315c3eb
UNION ordering undeprecated (#1113)
gem-neo4j Nov 27, 2024
1c27d45
Add cheat sheet tags for dynamic labels/types (#1117)
JPryce-Aklundh Nov 27, 2024
59969b1
Group all query plan operators (#1122)
JPryce-Aklundh Nov 29, 2024
f57877b
Add page-alias to CALL subquery page (#1127)
JPryce-Aklundh Dec 3, 2024
76cc351
Clarify that negative concurrency values in CiCT can only be done thr…
JPryce-Aklundh Dec 3, 2024
0513358
Cheat sheet tags for patterns and label expressions (#1125)
JPryce-Aklundh Dec 3, 2024
943a07a
Version to 2025.
stefano-ottolenghi Dec 9, 2024
9b2a5f1
Bump the prod-dependencies group with 2 updates (#1131)
dependabot[bot] Dec 18, 2024
c1cf139
Bump the dev-dependencies group across 1 directory with 2 updates (#1…
dependabot[bot] Dec 18, 2024
49d4013
Several small fixes to query plan ascii and links (#1136)
JPryce-Aklundh Dec 19, 2024
87dc968
Add Performance caveats section to Merge/Match dynamic labels section…
JPryce-Aklundh Dec 19, 2024
f0eecf4
Bump @neo4j-antora/antora-modify-sitemaps from 0.4.4 to 0.5.0 in the …
dependabot[bot] Jan 7, 2025
c20fe4a
Add dynamically referenced labels and types to allowed parameters (#1…
JPryce-Aklundh Jan 7, 2025
d5aeaec
document deprecation of graph names with unesacped dots in USE clause…
nadja-muller Jan 7, 2025
702f2af
Correct genai batchEncode example syntax (#1148)
JMHReif Jan 9, 2025
912325e
The Cypher query option `eagerAnalyzer` is deprecated (#1147)
blouerat Jan 9, 2025
d3adebd
Fix examples in Patterns / Syntax and semantics / shortestPaths (#1151)
dogofbrian Jan 9, 2025
13bfb4c
Explain trigram indexing for text-2.0 provider (#1152)
JPryce-Aklundh Jan 10, 2025
57ae186
Document lower bound restriction for shortestPath() and allShortestPa…
WilcoNeo Jan 10, 2025
612137c
Hyphenation (#1154)
JPryce-Aklundh Jan 10, 2025
e1047a2
Keyword priority (#1130)
hvub Jan 13, 2025
ab39719
Clarify YIELD (#1157)
JPryce-Aklundh Jan 14, 2025
fca175b
Bump @neo4j-antora/antora-modify-sitemaps from 0.5.0 to 0.6.0 in the …
dependabot[bot] Jan 14, 2025
09ee930
tags for READ query section (#1133)
rsill-neo4j Jan 14, 2025
d20cb4b
tags for clause section (#1138)
rsill-neo4j Jan 14, 2025
ea47a33
Alias to new keywords page (#1160)
JPryce-Aklundh Jan 14, 2025
ce32664
Property type rephrase (#1163)
JPryce-Aklundh Jan 15, 2025
32ccca0
fix antora for 2025.01 (#1164)
JPryce-Aklundh Jan 15, 2025
be0343d
Fix failing query plans (#1166)
JPryce-Aklundh Jan 16, 2025
fc34537
Table fixes, remove sitemap extension from playbook (#1167)
recrwplay Jan 16, 2025
0f8ffbd
Remove redundant antora attributes (#1168)
JPryce-Aklundh Jan 16, 2025
e493ce1
Clarify DETACH DELETE (#1156)
JPryce-Aklundh Jan 16, 2025
2b2241a
Bump @neo4j-antora/antora-table-footnotes from 0.3.2 to 0.3.3 in the …
dependabot[bot] Jan 21, 2025
899b365
Fix external links (#1172)
JPryce-Aklundh Jan 21, 2025
230001b
Remove invalid duration field (#1174)
gem-neo4j Jan 23, 2025
df9e288
Revert changes to pattern query plans (#1176)
JPryce-Aklundh Jan 28, 2025
c4762e7
Better Unicode example on Parsing page (#1177)
JPryce-Aklundh Jan 30, 2025
9c85b23
Fix tables (#1178)
JPryce-Aklundh Jan 30, 2025
4ceb45c
Bump @neo4j-antora/antora-modify-sitemaps from 0.6.0 to 0.6.1 in the …
dependabot[bot] Feb 4, 2025
aa05349
Update antora for 2025.02 (#1182)
JPryce-Aklundh Feb 4, 2025
4f0c318
Typo in example
stefano-ottolenghi Feb 12, 2025
cfec2cf
Add concurrency in GenAI example
stefano-ottolenghi Feb 12, 2025
4837369
Add examples to temporal instant values (#1189)
JPryce-Aklundh Feb 19, 2025
a40ace7
Fixes + sign formatting in deprecations page (#1192)
ikwattro Feb 21, 2025
56dd784
Added note on dynamic labels in INSERT (#1193)
JoelBergstrand Feb 21, 2025
277830d
Bump the prod-dependencies group with 2 updates (#1196)
dependabot[bot] Feb 25, 2025
807ebe2
Clarify predicate function and empty list behavior (#1197)
JPryce-Aklundh Feb 26, 2025
617c813
update antora for 2025.03 (#1200)
JPryce-Aklundh Feb 28, 2025
86b3a1e
remove developer survey (#1202)
recrwplay Feb 28, 2025
02b35f6
Cypher manual images refresh
lidiazuin Mar 4, 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
51 changes: 50 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
= Neo4j Cypher Manual

This page covers the following topics:

* xref:README.adoc#building-locally[]
* xref:README.adoc#raising-prs[]
* xref:README.adoc#documenting-changes[]
* xref:README.adoc#cypher-gql[]


[[building-locally]]
== Building locally

=== Prereqs
Expand Down Expand Up @@ -39,7 +48,7 @@ When you run `npm start`, the project is monitored for updates to asciidoc files

If a change to an asciidoc file is detected, the site is automatically rebuilt.


[[raising-prs]]
== Raising PRs


Expand Down Expand Up @@ -68,3 +77,43 @@ There are a few edge cases where we might want to work only on the current branc
** Create a feature branch from `dev`, to be merged into `dev` when appropriate.
* When a new version is ready to published, the `5.x` branch will get a git tag, named with the exact version (for example, **5.1.0**), signifying that this point-in-time marks the completion of the work for that minor release.
* Updates merged into the `dev` branch for the next release are cherry-picked into the `5.x` branch.

[[documenting-changes]]
== Documenting changes to Cypher

New, updated, deprecated, and removed features must be recorded on the xref:modules/ROOT/pages/deprecations-additions-removals-compatibility.adoc[Deprecations, additions, and compatibility] page.

New and deprecated features should also be marked with a label:

* If the impacted feature has its own header in the Cypher Manual, use the following:

....
[role=label--new-5.x]
== Header
....

....
[role=label--deprecated]
== Header
....

* If the impacted feature is documented within a table (such as a return column in a `SHOW` command), use the following:

`featureX` label:new[Introduced in 5.x] +
`featureY` label:deprecated[]

Labels can be difficult to apply to updated features.
In these cases, it is often preferable to note the change in a sentence.
For example: "As of Neo4j 5.x, `featureX` supports ..."

Removed features should be deleted from the Cypher Manual.

[[cypher-gql]]
== Cypher and GQL

When documenting a new Cypher feature, its relationship with GQL must be considered:

* If the feature is part of GQL's mandatory features, it should be recorded on the page xref:modules/ROOT/pages/appendix/gql-conformance/supported-mandatory.adoc[Supported mandatory GQL features].
* If the feature is part of GQL's optional features, it should be recorded on the page xref:modules/ROOT/pages/appendix/gql-conformance/supported-optional.adoc[Supported optional GQL features].
* if the feature adds functionality for which there exists an analogous, optional GQL feature, it should be recorded on the page xref:modules/ROOT/pages/appendix/gql-conformance/analogous-cypher.adoc[Optional GQL features and analogous Cypher].
* If the feature adds functionality for which there exists no GQL equivalent, it should be recorded on the page xref:modules/ROOT/pages/appendix/gql-conformance/additional-cypher.adoc[Additional Cypher features].
4 changes: 1 addition & 3 deletions antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,4 @@ nav:
- modules/ROOT/content-nav.adoc
asciidoc:
attributes:
neo4j-version: '5'
neo4j-version-minor: '5.25'
neo4j-version-exact: '5.25.0'
neo4j-version: '2025.03'
4 changes: 2 additions & 2 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,8 @@
** xref:indexes/syntax.adoc[]

* xref:constraints/index.adoc[]
** xref:constraints/managing-constraints.adoc[]
** xref:constraints/syntax.adoc[]
** xref:constraints/examples.adoc[]

* xref:planning-and-tuning/index.adoc[]
** xref:planning-and-tuning/execution-plans.adoc[]
Expand All @@ -116,7 +116,7 @@
** xref:syntax/parsing.adoc[]
** xref:syntax/naming.adoc[]
** xref:syntax/variables.adoc[]
** xref:syntax/reserved.adoc[]
** xref:syntax/keywords.adoc[]
** xref:syntax/parameters.adoc[]
** xref:syntax/operators.adoc[]
** xref:syntax/comments.adoc[]
Expand Down
27 changes: 27 additions & 0 deletions modules/ROOT/images/call-procedure.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion modules/ROOT/images/call_procedure.svg

This file was deleted.

10 changes: 5 additions & 5 deletions modules/ROOT/images/call_subquery_graph.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading