Errors for Graph Type #341

mnd999 · 2025-06-12T14:57:35Z

Error codes for graph types.

This work is likely to be feature flagged for some time, so we don't want to merge it to the public docs yet, but we do need to review the errors.

Hunterness

I haven't looked at the implementation PR but I did have some thoughts on the error messages from just looking at them in isolation.

Status: 0 open comment in this group and 1 in the next

modules/ROOT/pages/errors/gql-errors/22NC3.adoc

modules/ROOT/pages/errors/gql-errors/22NC4.adoc

modules/ROOT/pages/errors/gql-errors/22NC5.adoc

modules/ROOT/pages/errors/gql-errors/22NCA.adoc

modules/ROOT/pages/errors/gql-errors/22NCB.adoc

modules/ROOT/pages/errors/gql-errors/22NC7.adoc

modules/ROOT/pages/errors/gql-errors/22NC6.adoc

Hunterness · 2025-07-04T09:22:55Z

modules/ROOT/pages/errors/gql-errors/22NC6.adoc

+----
+ALTER CURRENT GRAPH TYPE SET {
+    (p:Person => {name :: STRING}),
+    CONSTRAINT FOR (p:Person =>) REQUIRE p.name IS NOT NULL,


do we want a second example where the node elem type and constraint have different properties (to show that it's not only a problem when the properties are the same)

I don't think we need to, if somebody is looking at this page, they already have the error.

maybe, but I just felt that since both the node and the relationship example had the same property it might be nice to also show some other cases that would fail

ALTER CURRENT GRAPH TYPE SET { (p:Person => {name :: STRING}), CONSTRAINT FOR (p:Person) REQUIRE p.ssn IS NOT NULL } Fix to: ALTER CURRENT GRAPH TYPE SET { (p:Person => {name :: STRING, ssn:: ANY NOT NULL}) }

(this both have another property and doesn't say we expect the label to be identifying in the constraint syntax)

I don't think we need any more examples, most of the error codes do not have any.

yeah, cause they didn't have time to add any when doing the initial docs, they want there to be examples for all codes (I've been asked to add examples when I updated codes previously) so that's not really a metric to go after

but if you don't want new/additional example then update the existing one instead: I just want some more variation in the examples and not have the very same case in both the node and relationship version (just switching which constraint type is where)

modules/ROOT/pages/errors/gql-errors/22NC6.adoc

Hunterness

New round of comments

Status: only open comments are from the groups above

modules/ROOT/pages/errors/gql-errors/22NC3.adoc

modules/ROOT/pages/errors/gql-errors/22NC8.adoc

Hunterness · 2025-07-17T08:51:26Z

modules/ROOT/pages/errors/gql-errors/22NC6.adoc

+----
+ALTER CURRENT GRAPH TYPE SET {
+    (p:Person => {name :: STRING}),
+    CONSTRAINT FOR (p:Person =>) REQUIRE p.name IS NOT NULL,


maybe, but I just felt that since both the node and the relationship example had the same property it might be nice to also show some other cases that would fail

ALTER CURRENT GRAPH TYPE SET { (p:Person => {name :: STRING}), CONSTRAINT FOR (p:Person) REQUIRE p.ssn IS NOT NULL } Fix to: ALTER CURRENT GRAPH TYPE SET { (p:Person => {name :: STRING, ssn:: ANY NOT NULL}) }

(this both have another property and doesn't say we expect the label to be identifying in the constraint syntax)

modules/ROOT/pages/errors/gql-errors/22NC6.adoc

modules/ROOT/pages/errors/gql-errors/22NC7.adoc

renetapopova

Many editorial comments, some of which require fixing the description in the codebase. When these are addressed, I'll build it locally and read it again. I also need to regenerate the index file to add the new codes.

modules/ROOT/partials/glossary.adoc

modules/ROOT/pages/errors/gql-errors/22NC9.adoc

modules/ROOT/pages/errors/gql-errors/22NC1.adoc

modules/ROOT/pages/errors/gql-errors/22NC2.adoc

modules/ROOT/pages/errors/gql-errors/22NC6.adoc

modules/ROOT/pages/errors/gql-errors/22NC7.adoc

modules/ROOT/pages/errors/gql-errors/22NC8.adoc

modules/ROOT/pages/errors/gql-errors/22NC9.adoc

modules/ROOT/pages/errors/gql-errors/22NC4.adoc

renetapopova

Looks good. A few minor comments.

modules/ROOT/pages/errors/gql-errors/22NC4.adoc

modules/ROOT/pages/errors/gql-errors/22NC5.adoc

modules/ROOT/pages/errors/gql-errors/22NC8.adoc

modules/ROOT/pages/errors/gql-errors/22NC9.adoc

Hunterness

Noticed when double checking the messages and the impl updates

modules/ROOT/pages/errors/gql-errors/22NC8.adoc

Co-authored-by: Therese Magnusson <[email protected]>

neo4j-docops-agent · 2025-09-03T16:12:48Z

This PR includes documentation updates
View the updated docs at https://neo4j-docs-status-codes-341.surge.sh

New pages:

Updated pages:

List of GQLSTATUS error codes

Hunterness

Review of new errors (and a brief look through the old)

Hunterness · 2025-10-01T10:53:56Z

modules/ROOT/pages/errors/gql-errors/22NC5.adoc

+    CONSTRAINT FOR () REQUIRE n.prop IS UNIQUE
+----


Suggested change

CONSTRAINT FOR () REQUIRE n.prop IS UNIQUE

----

CONSTRAINT FOR () REQUIRE n.prop IS UNIQUE

}

----

Hunterness · 2025-10-01T10:54:25Z

modules/ROOT/pages/errors/gql-errors/22NC5.adoc

+    CONSTRAINT FOR (n:Node) REQUIRE n.prop IS UNIQUE
+----


Suggested change

CONSTRAINT FOR (n:Node) REQUIRE n.prop IS UNIQUE

----

CONSTRAINT FOR (n:Node) REQUIRE n.prop IS UNIQUE

}

----

Hunterness · 2025-10-01T11:00:32Z

modules/ROOT/pages/errors/gql-errors/22NCB.adoc

+
+[source]
+----
+error: data exception - relationship element type already exists. A relationship element type identified by the relationship type `REL` already exists in the graph type."


Suggested change

error: data exception - relationship element type already exists. A relationship element type identified by the relationship type `REL` already exists in the graph type."

error: data exception - relationship element type already exists. A relationship element type identified by the relationship type `REL` already exists in the graph type.

Hunterness · 2025-10-01T11:04:35Z

modules/ROOT/pages/errors/gql-errors/22NCD.adoc

+
+[source]
+----
+error: data exception - relationship element type specified incorrectly. The relationship element type identified by the relationship type `REL` is different to the one specified in the query.


would it be possible for this error (and the node one) to either show the diff or the full existing type 🤔 I got this error when missing the => on my end node which took a bit to figure out (and some call to show XD) and having the diff or type definition would maybe have helped figure it out faster 🤷

Hunterness · 2025-10-01T11:05:35Z

modules/ROOT/pages/errors/gql-errors/22NCE.adoc

+    (p:Person => {name :: STRING })
+    (p)-[:DRIVES]->(:Car)


Suggested change

(p:Person => {name :: STRING })

(p)-[:DRIVES]->(:Car)

(p:Person => {name :: STRING }),

(p)-[:DRIVES]->(:Car)

Hunterness · 2025-10-01T11:11:04Z

modules/ROOT/pages/errors/gql-errors/22NCF.adoc

+error: data exception - graph type constraint not supported. Graph type constraint definitions are not supported in the `{ <<graphTypeOperation>> }` operation.
+
+== Explanation
+


don't we want an explanation here?

Hunterness · 2025-10-01T11:13:47Z

modules/ROOT/pages/errors/gql-errors/22NCF.adoc

+[source,cypher]
+----
+ALTER CURRENT GRAPH TYPE ALTER {
+    CONSTRAINT c1 FOR (s:Student) REQUIRE s.studentId :: STRING 


Since Gowri have (multiple times) stumbled on the inline key constraints it might be nice with an example of that as well

Given ALTER CURRENT GRAPH TYPE SET { (:Label => :ToBeRemoved {prop :: STRING IS KEY}) } Then: ALTER CURRENT GRAPH TYPE ALTER { (:Label => {prop :: STRING IS KEY}) }

I see that you have it for DROP, but I think Gowri have had more questions on it for ALTER 🤷

Hunterness · 2025-10-01T11:15:08Z

modules/ROOT/pages/errors/gql-errors/22NCF.adoc

+}
+ALTER CURRENT GRAPH TYPE ADD {


would we need some indication that these are two queries and not one containing two alter clauses? 🤔 (since this would fail parsing on the second ALTER I'd assume)

Hunterness · 2025-10-01T11:17:03Z

modules/ROOT/pages/errors/gql-errors/index.adoc

+=== xref:errors/gql-errors/22NC9.adoc[22NC9]
+
+Status description:: error: data exception - invalid element type constraints in graph type. A `{ <<entityType>>1 }` element type property `{ <<context>> }` constraint cannot be specified inline of a `{ <<entityType>>2 }` element type.



missing 22NCA-F?

Hunterness · 2025-10-01T11:17:41Z

modules/ROOT/pages/errors/gql-errors/index.adoc

 Status description:: error: data exception - unsupported struct tag. Unsupported struct tag: 0x56. `{ <<value>> }`.
+=== xref:errors/gql-errors/22NC1.adoc[22NC1]


Suggested change

Status description:: error: data exception - unsupported struct tag. Unsupported struct tag: 0x56. `{ <<value>> }`.

=== xref:errors/gql-errors/22NC1.adoc[22NC1]

Status description:: error: data exception - unsupported struct tag. Unsupported struct tag: 0x56. `{ <<value>> }`.

=== xref:errors/gql-errors/22NC1.adoc[22NC1]

mnd999 added dev The default branch. DO NOT MERGE cypher-25 labels Jun 12, 2025

mnd999 marked this pull request as ready for review June 16, 2025 09:14

mnd999 force-pushed the graph-type-errors branch from 85e42a1 to d27c275 Compare June 16, 2025 09:15

mnd999 assigned Hunterness Jun 19, 2025

Hunterness reviewed Jun 27, 2025

View reviewed changes

mnd999 force-pushed the graph-type-errors branch from 9eff486 to af24129 Compare July 2, 2025 14:14

Hunterness reviewed Jul 4, 2025

View reviewed changes

mnd999 force-pushed the graph-type-errors branch 2 times, most recently from 7d5bab3 to e25ea42 Compare July 17, 2025 07:57

Hunterness reviewed Jul 17, 2025

View reviewed changes

renetapopova requested changes Jul 18, 2025

View reviewed changes

Hunterness reviewed Jul 21, 2025

View reviewed changes

modules/ROOT/pages/errors/gql-errors/22NC4.adoc Show resolved Hide resolved

renetapopova reviewed Jul 22, 2025

View reviewed changes

Hunterness reviewed Jul 24, 2025

View reviewed changes

modules/ROOT/pages/errors/gql-errors/22NC8.adoc Outdated Show resolved Hide resolved

renetapopova self-requested a review July 25, 2025 11:34

renetapopova force-pushed the graph-type-errors branch from 0ed16b5 to 0098fca Compare July 25, 2025 11:35

renetapopova approved these changes Jul 25, 2025

View reviewed changes

NataliaIvakina mentioned this pull request Aug 21, 2025

Introduce 22NBD - Unsupported Struct #371

Merged

mnd999 and others added 2 commits September 3, 2025 14:09

Error status codes for GRAPH TYPE

a293a11

Apply suggestions from code review

c8ec980

Co-authored-by: Therese Magnusson <[email protected]>

mnd999 force-pushed the graph-type-errors branch from 0098fca to c8ec980 Compare September 3, 2025 13:13

Rough sketch of the remaining error codes

a25ddb0

Hunterness reviewed Oct 1, 2025

View reviewed changes

	error: data exception - relationship element type already exists. A relationship element type identified by the relationship type `REL` already exists in the graph type."
	error: data exception - relationship element type already exists. A relationship element type identified by the relationship type `REL` already exists in the graph type.

		error: data exception - graph type constraint not supported. Graph type constraint definitions are not supported in the `{ <<graphTypeOperation>> }` operation.

		== Explanation

		=== xref:errors/gql-errors/22NC9.adoc[22NC9]

		Status description:: error: data exception - invalid element type constraints in graph type. A `{ <<entityType>>1 }` element type property `{ <<context>> }` constraint cannot be specified inline of a `{ <<entityType>>2 }` element type.

		Status description:: error: data exception - unsupported struct tag. Unsupported struct tag: 0x56. `{ <<value>> }`.
		=== xref:errors/gql-errors/22NC1.adoc[22NC1]

Errors for Graph Type #341

Are you sure you want to change the base?

Errors for Graph Type #341

Conversation

mnd999 commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Hunterness left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Hunterness left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

renetapopova left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

renetapopova left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Hunterness left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

neo4j-docops-agent commented Sep 3, 2025

Uh oh!

Hunterness left a comment

Choose a reason for hiding this comment

mnd999 commented Jun 12, 2025 •

edited

Loading

Hunterness left a comment •

edited

Loading

Hunterness left a comment •

edited

Loading