Releases: neo4j/docs-cypher
Releases · neo4j/docs-cypher
2025.04.0: Update styleguide with cypherfmt rules and recommend its usage (#1289)
## Description Hey, docs team! For the past few months, as a master's thesis project, @simonthuresson and I have been working on a formatter for Cypher. In short, the formatter formats a Cypher query so that it follows the styleguide recommendations. During development, we found that the styleguide is quite far from comprehensive, and also some of the cypher snippets in the docs disagree with it as well. Filling out the missing pieces and addressing any ambiguity became a fairly large part of our project, and we wrote extensively about how we did so in our thesis, which you can find here: - [An Evaluation of Approaches to Code Formatting](https://lup.lub.lu.se/luur/download?func=downloadFile&recordOId=9188816&fileOId=9188817) In short, we did a survey on styling preferences, and talked to Cypher users to try and figure out what the most preferred way of writing Cypher was. We then took those learnings and implemented it in our formatter so that it could automatically enforce the rules. This PR is a draft of how we think the styleguide should be updated in accordance with the new rules. I did not put a lot of time into the wording and structure of the recommendations, as I would prefer to leave that to the professionals (you), but I provided some examples which hopefully illustrate the ideas well. If you want more detailed context on the rules, refer to the thesis (chapter 4 specifically). I also included a recommendation at the start of the style guide that users should use our formatter, as manual formatting is generally not a great idea. #### Note I included a link to the language support npm package that I claim provides a command-line tool. This is not actually live yet, but will be soon: https://github.com/neo4j/cypher-language-support/pull/518 ## Try it out If you want to get a better feel for how the formatter works and how it applies the rules, you can try it out in: - Query in the Aura console (the ... menu -> format query) - [The Cypher Language Support CodeMirror playground](https://neo4j.github.io/cypher-language-support/) - [VS Code](https://marketplace.visualstudio.com/items?itemName=neo4j-extensions.neo4j-for-vscode) I would also recommend running any Cypher queries you add to the docs through the formatter first, to ensure that the styling is always consistent across all documentation. ## Note This is my last day at Neo4j, so I probably will not be able to respond to any comments on this PR. If you have questions, direct them at the language support team (#team-cypher-language-support), they have reviewed every line of code in the formatter, and are well aware of how it works. Feel free to completely change the wording I have used, this is just a first draft that I wanted to get in before leaving. --------- Co-authored-by: Jens Pryce-Åklundh <112686610+JPryce-Aklundh@users.noreply.github.com>
2025.03.0
fix variable names (#1261)
2025.02.0: fix SHORTEST note (#1217)
Co-authored-by: Neil Dewhurst <ndewhurst@gmail.com>
2025.01.0
5.26.0
What's Changed
- Bump the prod-dependencies group with 2 updates by @dependabot in #1001
- Add TIME ZONE alias by @gem-neo4j in #1010
- Fix result format of relationships function by @JPryce-Aklundh in #1011
- Document Variable Scope Clause by @JPryce-Aklundh in #990
- Fix typos on parsing page by @JPryce-Aklundh in #1014
- Add further considerations for CASE expressions by @gem-neo4j in #1013
- Remove link to Cartesian CRSs by @JPryce-Aklundh in #1016
- Fix typo in Patterns reference by @JPryce-Aklundh in #1017
- adding health warning about insecure protocols for LOAD CSV by @phil198 in #1006
- fix GQL table and update on CALL by @JPryce-Aklundh in #1018
- link description correction by @phil198 in #1020
- Remove Enterprise Edition label from GenAI plugin page by @JPryce-Aklundh in #1019
- Update GQL wording by @JPryce-Aklundh in #1021
- Update remaining queries using shortestPath() by @JPryce-Aklundh in #1022
- Add new vector index settings by @parnmatt in #1009
- Correct documentation on comparing spatial values by @JPryce-Aklundh in #1023
- Add information about Text indexes and dictionary variables by @JPryce-Aklundh in #1026
- Add alias for index page by @JPryce-Aklundh in #1029
- normalise vector index settings achors by @parnmatt in #1030
- update antora for 5.24 by @JPryce-Aklundh in #1032
- Add docs on dynamic properties by @gem-neo4j in #972
- Add note clarifying DELETE does not free up disk space by @JPryce-Aklundh in #1025
- Add new Function detail tables (inluding new argument descriptions) by @JPryce-Aklundh in #1024
- Standalone Order by, Skip/Offset, and Limit by @JoelBergstrand in #1027
- Add azure import example by @fabiim in #1008
- LOAD CSV fixes by @JPryce-Aklundh in #1037
- Add brittleness information to id()/elementId() functions by @JPryce-Aklundh in #1035
- Clean up some function pages by @JPryce-Aklundh in #1039
- fix CALL query in clause composition page by @JPryce-Aklundh in #1038
- Document Cypher features that are not in GQL by @JPryce-Aklundh in #1033
- Fix plans for Repeat(trail) and NullifyMetaData by @JPryce-Aklundh in #1043
- Document OPTIONAL CALL by @JPryce-Aklundh in #1034
- Bump express from 4.19.2 to 4.21.0 in the dev-dependencies group by @dependabot in #1044
- Bump nodemon from 3.1.4 to 3.1.7 in the dev-dependencies group by @dependabot in #1048
- Added
DROP DATABASE name CASCADE ALIASES
by @Hunterness in #1036 - adding property rules to 5.21 additions by @phil198 in #1046
- adding Auth Providers to deprecations-additions-removals-compatibility by @phil198 in #1042
- Update antora for 5.25 by @JPryce-Aklundh in #1050
- Fix optional call link by @JPryce-Aklundh in #1051
- Bump @neo4j-documentation/macros from 1.0.2 to 1.0.4 in the prod-dependencies group by @dependabot in #1052
- Add Nodes 24 ad by @recrwplay in #1053
- Fix links to Auth providers in Ops Manual by @JPryce-Aklundh in #1054
- fix link to image by @recrwplay in #1055
- Clarify CALL subquery ambiguities by @JPryce-Aklundh in #1060
- Deprecate
existingDataSeedInstance
option to CREATE DATABASE by @mnd999 in #1047 - Bump express from 4.21.0 to 4.21.1 in the dev-dependencies group by @dependabot in #1061
- clarify point.distance function by @JPryce-Aklundh in #1064
- fix functions table (Logarithmic was missing) by @JPryce-Aklundh in #1065
- Restructure Constraints section by @JPryce-Aklundh in #1041
- Add new label to type constraints and page alias by @JPryce-Aklundh in #1066
- Fix typo and change auradb enterprise to auradb virtual dedicated cloud on parallel runtime page by @JPryce-Aklundh in #1068
- Intro with a link to ops manual for cloud URI section by @rsill-neo4j in #1071
- Make Cypher Manual AuraDB Business Critical aware by @JPryce-Aklundh in #1072
- Fix remaining examples of CALL subqueries without variable scope clause by @JPryce-Aklundh in #1074
- Fix SHOW CONSTRAINTS table by @JPryce-Aklundh in #1075
- Aura update for parallel runtime by @JPryce-Aklundh in #1076
- Document max identifier length by @JPryce-Aklundh in #1077
- Add missing curly bracket by @JPryce-Aklundh in #1079
- Update MATCH page by @JPryce-Aklundh in #1080
- Small fix to MATCH by @JPryce-Aklundh in #1085
- Remove mentions of Neo4j 6.0 by @JPryce-Aklundh in #1086
- Fix cos() table by @JPryce-Aklundh in #1087
- update antora for 5.26 by @JPryce-Aklundh in #1091
- Include statements for functions section by @rsill-neo4j in #1004
- Document change in behaviour for db.schema.nodeTypeProperties() and db.schema.relTypeProperties() by @gem-neo4j in #1063
- Adding the new functionality of property-based access control to list of new features by @HannesSandberg in #1070
- Add entry in additions/removals about parameters in CREATE/ALTER DB TOPOLOGY by @l-heemann in #1082
- Fix version exact roles by @JPryce-Aklundh in #1095
- cip-190 deprecations by @hvub in #1084
- Remove use of index-provider option by @emmaholmbergohlsson in #1096
- Update README to include documenting changes to language and GQL by @JPryce-Aklundh in #1100
- Document the deprecation of the
indexProvider
option by @l-heemann in #1101 - Further deprecations to options in CREATE DATABASE by @mnd999 in #1083
- Change SHOW SETTINGS filter query example by @JPryce-Aklundh in #1103
- Explain return values from vector functions by @JPryce-Aklundh in #1104
- fix xref on LOAD CSV page by @JPryce-Aklundh in #1107
- Fix links to the Operations manual by @NataliaIvakina in #1106
- Document old deprecation for database naming by @mnd999 in #1105
- use quote in backticks rather than escape by @JPryce-Aklundh in #1111
- Typo fix by @juantoser in #1110
- Replace NODES ad with developer survey by @recrwplay in #1112
- Dynamic labels/types by @JPryce-Aklundh in #1098
- Fix vector config performance suggestion by @JPryce-Aklundh in #1115
- add complete fulltext stop words and clarify populating state by @JPryce-Aklundh in #1116
- Fix failing query example by @JPryce-Aklundh in #1119
- Document the availability of graph.byelementid on standard databases by @JPryce-Aklundh in #1120
- UNION ordering undeprecated by @gem-neo4j in #1113
- Add cheat sheet tags for dynamic labels/types by @JPryce-Aklundh in #1117
- Group all query plan operators by @JPryce-Aklundh in #1122
- Add page-alias to CALL subquery page b...
5.24.0
5.23.0
adding property rules to 5.21 additions (#1046) Co-authored-by: Jens Pryce-Åklundh <112686610+JPryce-Aklundh@users.noreply.github.com>
5.20.0
Adding stable ids to all changes in 5.0 to be linkable (#988) This will be used by Aura migration readiness report
5.19.0
What's Changed
- 5.18 publish by @JPryce-Aklundh in #922
- Correct Cypher Example in load-csv.adoc by @zach-blumenfeld in #937
- 5.19 publish by @JPryce-Aklundh in #945
- GQL conformance documentation (#951) by @JPryce-Aklundh in #953
- Fix typo in date truncation documentation by @smithna in #959
New Contributors
- @zach-blumenfeld made their first contribution in #937
- @smithna made their first contribution in #959
Full Changelog: 5.17.0...5.19.0
5.17.0
What's Changed
- Fix bad GenAI batching example (#891) by @renetapopova in #894
- Update comment about all available types under list of allowed types for property type constraints (#899) by @JPryce-Aklundh in #902
- Page aliases fix for version selector by @lidiazuin in #881
- Update link to CALL in tx page from DELETE page (#904) by @JPryce-Aklundh in #905
- Remove DS store (#907) by @JPryce-Aklundh in #908
- Cherry-pick PRs 892 + 893 by @JPryce-Aklundh in #909
- Change new[5.17] labels to text in index and constraints pages. (#910) by @JPryce-Aklundh in #911
- typo fix (#914) by @JPryce-Aklundh in #915
Full Changelog: 5.16.0...5.17.0