Skip to content

Fix deprecation examples #269

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

Closed
wants to merge 2 commits into from
Closed

Fix deprecation examples #269

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75e5eb3
Fix deprecation examples
renetapopova Feb 26, 2025
26f513c
put back cdc.query example and move the other two under deprecated wi…
renetapopova Feb 28, 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
170 changes: 89 additions & 81 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 @@ -1910,7 +1910,7 @@ CREATE TEXT INDEX FOR (n:Label) ON (n.prop) OPTIONS {indexProvider : 'text-2.0'}
======
[source,cypher]
----
CALL cdc.query
CALL cdc.query()
----

Returned GQLSTATUS code::
Expand All @@ -1921,85 +1921,14 @@ warn: feature deprecated with replacement.
`cdc.query` is deprecated.
It is replaced by `db.cdc.query`.

======
[.include-with-GQLSTATUS-deprecated-without-replacement]
======
[source,cypher]
----
CALL unsupported.dbms.shutdown
----

Returned GQLSTATUS code::
01N02

Returned status description::
warn: feature deprecated without replacement.
`unsupported.dbms.shutdown` is deprecated and will be removed without a replacement.
======
[.include-with-neo4j-code]
======

[source,cypher]
----
CALL unsupported.dbms.shutdown
----

Description of the returned code::
The query used a deprecated procedure: `'unsupported.dbms.shutdown'`.

Suggestions for improvement::
Remove the use of the deprecated procedure.
If there is a suggested replacement, update to use the replacement instead.

======
=====

.Using id() function
[.tabbed-example]
=====
[.include-with-GQLSTATUS-deprecated-with-replacement]
======
Query::
Use the new procedure name `db.cdc.query` instead of the deprecated `cdc.query`.
+
[source,cypher]
----
MATCH (a)
RETURN id(a)
CALL db.cdc.query()
----

Returned GQLSTATUS code::
01N01

Returned status description::
warn: feature deprecated with replacement.
`id` is deprecated.
It is replaced by `elementId()`.

Suggestions for improvement::
Use the function `elementId()` instead.
+
[source,cypher]
----
MATCH (a)
RETURN elementId(a)
----
======
[.include-with-GQLSTATUS-deprecated-without-replacement]
======
Query::
+
[source,cypher]
----
MATCH (a)
RETURN id(a)
----

Returned GQLSTATUS code::
01N02

Returned status description::
warn: feature deprecated without replacement.
`id` is deprecated and will be removed without a replacement.
Comment on lines -1970 to -2002
Copy link
Contributor

Choose a reason for hiding this comment

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

Given that https://github.com/neo-technology/neo4j/pull/29918 is merged now, you should revert the change regarding the id function and adjust to the message that points not only to elementId but also "an application-generated id".

It is replaced by elementId or an application-generated id

======
[.include-with-neo4j-code]
======
Expand All @@ -2008,21 +1937,20 @@ Query::
+
[source,cypher]
----
MATCH (a)
RETURN id(a)
CALL cdc.query()
----

Description of the returned code::
The query used a deprecated function: `id`.
The query used a deprecated procedure. ('cdc.query' has been replaced by 'db.cdc.query')

Suggestions for improvement::
Use the function `elementId()` instead.
Use the new procedure name `db.cdc.query` instead of the deprecated `cdc.query`.
+
[source,cypher]
----
MATCH (a)
RETURN elementId(a)
CALL db.cdc.query()
----

======
=====

Expand Down Expand Up @@ -2630,6 +2558,86 @@ m|DEPRECATION
m|WARNING
|===

.Using a renamed or a deprecated procedure
[.tabbed-example]
=====
[.include-with-GQLSTATUS-deprecated-without-replacement]
======
[source,cypher]
----
CALL unsupported.dbms.shutdown()
----

Returned GQLSTATUS code::
01N02

Returned status description::
warn: feature deprecated without replacement.
`unsupported.dbms.shutdown` is deprecated and will be removed without a replacement.
======
[.include-with-neo4j-code]
======

[source,cypher]
----
CALL unsupported.dbms.shutdown()
----

Description of the returned code::
The query used a deprecated procedure: `'unsupported.dbms.shutdown'`.

Suggestions for improvement::
Remove the use of the deprecated procedure.
If there is a suggested replacement, update to use the replacement instead.

======
=====

.Using id() function
[.tabbed-example]
=====
[.include-with-GQLSTATUS-deprecated-without-replacement]
======
Query::
+
[source,cypher]
----
MATCH (a)
RETURN id(a)
----

Returned GQLSTATUS code::
01N02

Returned status description::
warn: feature deprecated without replacement.
`id` is deprecated and will be removed without a replacement.
======
[.include-with-neo4j-code]
======

Query::
+
[source,cypher]
----
MATCH (a)
RETURN id(a)
----

Description of the returned code::
The query used a deprecated function: `id`.

Suggestions for improvement::
Use the function `elementId()` instead.
+
[source,cypher]
----
MATCH (a)
RETURN elementId(a)
----
======
=====

.Using Cypher query option `connectComponentsPlanner`
[.tabbed-example]
=====
Expand Down Expand Up @@ -3604,7 +3612,7 @@ m|SECURITY
|GQLSTATUS code
m|01N72
|Status description
a|warn: insecure URL protocol. Query uses an insecure protocol. Consider using 'https' instead.
a|warn: insecure URL protocol. Query uses an insecure protocol. Consider using 'https' instead.
|Classification
m|SECURITY
|SeverityLevel
Expand Down