Skip to content

Added examples of notifications connected to deprecated namespaces #394

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

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open

Added examples of notifications connected to deprecated namespaces #394

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
00594f3
Added examples of notifications connected to deprecated namespaces
JoelBergstrand Oct 21, 2025
347a443
Update modules/ROOT/pages/notifications/all-notifications.adoc
JoelBergstrand Oct 22, 2025
6b2e73c
Updated suggestion and warning
JoelBergstrand Oct 22, 2025
90b7db6
fix the tab examples rendering
renetapopova Oct 27, 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
110 changes: 110 additions & 0 deletions modules/ROOT/pages/notifications/all-notifications.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1555,6 +1555,116 @@ The Unicode character `\u0085` is deprecated for unescaped identifiers and will
======
=====

.Deprecated function namespace
[.tabbed-example]
=====
[.include-with-GQLSTATUS-code]
======
Query::
+
[source,cypher]
----
RETURN point.function() AS result
----

Returned GQLSTATUS code::
01N00

Returned status description::
warn: feature deprecated.
The namespace used by the user-defined function `point.function` is deprecated.

Suggestions for improvement::
Change the namespace to a non-deprecated namespace e.g. `my.point.function` or `pointing.function`.

======
[.include-with-neo4j-code]
======
Query::
+
[source,cypher]
----
RETURN point.function() AS result
----
Description of the returned code::
The namespace of the invoked user-defined function is deprecated. (point.function)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we allowed to change the neo4j codes' descriptions? As far as I know, this would be a breaking change.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The descriptions should match the codebase. If we change them here, we need to change them there as well.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes in this case it is fine because the description is brand new for this feature so it is not breaking for anyone yet to change it

======
=====

.Deprecated procedure namespace
[.tabbed-example]
=====
[.include-with-GQLSTATUS-code]
======
Query::
+
[source,cypher]
----
CALL point.procedure() AS result
RETURN result
----

Returned GQLSTATUS code::
01N00

Returned status description::
warn: feature deprecated.
The namespace used by the user-defined procedure `point.procedure` is deprecated.

Suggestions for improvement::
Change the namespace to a non-deprecated namespace e.g. `my.point.procedure` or `pointing.procedure`.

======
[.include-with-neo4j-code]
======
Query::
+
[source,cypher]
----
CALL point.procedure() AS result
RETURN result
----
Description of the returned code::
The namespace of the called user-defined procedure is deprecated. (point.procedure)
======
=====

.Shadowing built-in function
[.tabbed-example]
=====
[.include-with-GQLSTATUS-code]
======
Query::
+
[source,cypher]
----
RETURN coll.flatten() AS result
----

Returned GQLSTATUS code::
01N00

Returned status description::
warn: feature deprecated.
The namespace of the invoked user-defined function `coll.flatten` is deprecated and the function is shadowing an internal function.

Suggestions for improvement::
Change the namespace to a non-deprecated namespace e.g. `my.coll.flatten` or `collection.flatten`.

======
[.include-with-neo4j-code]
======
Query::
+
[source,cypher]
----
RETURN coll.flatten() AS result
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, this one, never heard of it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

coll.flatten is in the pipeline to be implemented. Hopefully in 2025.11 as well. This notification shows when a used defined function shadows a builtin function that is in a deprecated namespace.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see. Then, we should make sure that this PR is merged after coll.flatten is implemented.

----
Description of the returned code::
The namespace of the invoked user-defined function is deprecated and the function is shadowing an internal function. (coll.flatten)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is also a table 15 further up with all possible descriptions for 01N00 where you could add these as well.

======
=====

[#_deprecated-feature-with-replacement]
=== Feature deprecated with a replacement

Expand Down