Skip to content

Deprecate connectComponentsPlanner #468

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

Merged
merged 3 commits into from
Mar 22, 2023
Merged

Deprecate connectComponentsPlanner #468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
84571f7
Deprecate `connectComponentsPlanner`
sherfert Mar 9, 2023
2b2782d
Reword deprecation message.
sherfert Mar 17, 2023
94bd0c3
Merge branch 'dev' into deprecate-ccp
JPryce-Aklundh Mar 22, 2023
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
28 changes: 28 additions & 0 deletions modules/ROOT/pages/deprecations-additions-removals-compatibility.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,34 @@ New features are added to the language continuously, and occasionally, some feat
This section lists all of the features that have been removed, deprecated, added, or extended in different Cypher versions.
Replacement syntax for deprecated and removed features are also indicated.

[[cypher-deprecations-additions-removals-5.7]]
== Version 5.7

=== Deprecated features

[cols="2", options="header"]
|===
| Feature
| Details

a|
label:functionality[]
label:deprecated[]
[source, cypher, role="noheader"]
----
CYPHER connectComponentsPlanner=greedy MATCH (a), (b) RETURN *
----

[source, cypher, role="noheader"]
----
CYPHER connectComponentsPlanner=idp MATCH (a), (b) RETURN *
----
a|

The Cypher query option `connectComponentsPlanner` is deprecated and will be removed without a replacement.
The product's default behavior of using a cost-based IDP search algorithm when combining sub-plans will be kept.
|===

[[cypher-deprecations-additions-removals-5.6]]
== Version 5.6

Expand Down
8 changes: 7 additions & 1 deletion modules/ROOT/pages/query-tuning/query-options.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Using this option can significantly _increase_ the planning time of the query.


[[cypher-connect-components-planner]]
== Cypher connect-components planner
== Cypher connect-components planner label:deprecated[]
Copy link
Contributor

@AzuObs AzuObs Mar 10, 2023

Choose a reason for hiding this comment

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

Screenshot 2023-03-10 at 09 16 29

The rendering is perhaps a little weird but I'm not sure that's something you can easily solve

Copy link
Contributor

@arnefischereit arnefischereit Mar 10, 2023

Choose a reason for hiding this comment

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

I guess that is a general problem in the docs at the moment.
We had some similar issues with code environments when discussing the new manual's structure with @JPryce-Aklundh .

Copy link
Collaborator

@JPryce-Aklundh JPryce-Aklundh Mar 10, 2023

Choose a reason for hiding this comment

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

We are currently having some trouble with the ui-bundle. I will bring this example to the team and hopefully we will have a fix soon.


One part of the Cypher planner is responsible for combining sub-plans for separate patterns into larger plans - a task referred to as _connecting components_.

Expand Down Expand Up @@ -117,6 +117,12 @@ Using this option can significantly _increase_ the planning time of the query bu

|===

[IMPORTANT]
====
The Cypher query option `connectComponentsPlanner` is deprecated and will be removed without a replacement.
The product's default behavior of using a cost-based IDP search algorithm when combining sub-plans will be kept.
====


[[cypher-update-strategy]]
== Cypher update strategy
Expand Down