Skip to content
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

Jump to bottom

Add seed restore until section and remove 5.x seed provider info #2002

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

Add seed restore until section and remove 5.x seed provider info #2002

wants to merge 7 commits into from

Conversation

jackwaudby
Copy link
Contributor

  • Remove 5.x specific documentation from 'Seed from URI' section
  • Add section on seedRestoreUntil option

@NataliaIvakina NataliaIvakina self-assigned this Dec 10, 2024
@NataliaIvakina NataliaIvakina self-requested a review December 19, 2024 07:55
NataliaIvakina
NataliaIvakina reviewed Dec 19, 2024
View reviewed changes
modules/ROOT/pages/clustering/databases.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/clustering/databases.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/clustering/databases.adoc Show resolved Hide resolved
modules/ROOT/pages/clustering/databases.adoc Outdated Show resolved Hide resolved
@neo-technology-commit-status-publisher
Copy link
Collaborator

This PR includes documentation updates
View the updated docs at https://neo4j-docs-operations-2002.surge.sh

Updated pages:

@jackwaudby
Copy link
Contributor Author

@NataliaIvakina the seed restore functionality/syntax will only be available in Cypher 25 which I believe won't be available until at least 2025.02? In which case how is best to proceed here, delay merging until 2025.02? As a side question do we have to clarify whether each section/functionality/example is compatible with Cypher 25 and/or Cypher 5?

@NataliaIvakina
Copy link
Contributor

@NataliaIvakina the seed restore functionality/syntax will only be available in Cypher 25 which I believe won't be available until at least 2025.02? In which case how is best to proceed here, delay merging until 2025.02? As a side question do we have to clarify whether each section/functionality/example is compatible with Cypher 25 and/or Cypher 5?

@jackwaudby, these are very good questions! I didn't know that Cypher 25 will be released later than Neo4j 2025.01. It complicates things.

Are you talking about the 'seedRestoreUntil' option? This option will be available only in Cypher 25, won't it?
If so, I think it makes no sense to merge the PR with the 2025.01 release if functionality is not available. Let's wait till 2025.02 and Cypher 25 to be released.

I suppose if a feature is available only in Cypher 25, we have to label it accordingly.
Do I understand correctly that this functionality is not available in Cypher 5? If so, we have to put a label, e.g., 'Not available in Cypher 5'.

@jackwaudby
Copy link
Contributor Author

jackwaudby commented Dec 19, 2024 •
edited
Loading

I didn't know that Cypher 25 will be released later than Neo4j 2025.01.

Neither did I, I only found out yesterday (apparently it could still be later than 2025.01 as well). TBH somebody probably did tell me before but I wasn't listening 😆

Are you talking about the 'seedRestoreUntil' option? This option will be available only in Cypher 25, won't it?
If so, I think it makes no sense to merge the PR with the 2025.01 release if functionality is not available. Let's wait till 2025.02 and Cypher 25 to be released.

Yes, sounds good. Let's wait until 2025.02.

Do I understand correctly that this functionality is not available in Cypher 5?

Yes correct, this is not available in Cypher 5.

NataliaIvakina
NataliaIvakina reviewed Dec 23, 2024
View reviewed changes
modules/ROOT/pages/clustering/databases.adoc
@@ -513,26 +513,25 @@ label:new[Introduced in 5.26], the `FileSeedProvider` supports:

The `URLConnectionSeedProvider` supports the following:

** `file:` label:deprecated[Deprecated in 5.26]
Copy link
Contributor

Choose a reason for hiding this comment

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

Does it mean that support for file is removed? If so, in which Neo4j and Cypher versions?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

From Neo4j 2025.01 file is supported only with the FileSeedProvider. This is true for both Cypher 5 and Cypher 25.

modules/ROOT/pages/clustering/databases.adoc
@@ -620,8 +605,7 @@ Where `accessKey` and `secretKey` are provided by AWS.
| URI example

| `file:`
| `URLConnectionSeedProvider` label:deprecated[Deprecated in 5.26], +
Copy link
Contributor

Choose a reason for hiding this comment

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

removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The URLConnectionSeedProvider remains in 2025.01 but only supports http, ftp and https now.

modules/ROOT/pages/clustering/databases.adoc
@@ -573,43 +572,29 @@ CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 'azb://myStorageAcco
======
=====

[[s3-seed-provider]]
Copy link
Contributor

Choose a reason for hiding this comment

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

the same question. Is this option removed? In which Neo4j and Cypher versions?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

From Neo4j 2025.01 s3 is supported only with the CloudSeedProvider. This is true for both Cypher 5 and Cypher 25 running on 2025.01.

However, in theory it would work if a user run Cypher 5 on 2025.01 and used the S3SeedProvider but it is not the approach we want to encourage.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think there is a balancing act to be done here. The S3SeedProvider still exists in order to support the Cypher 5 usage of it. So it needs to remain in the docs, but be clearly 'Cypher 5 only'.

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change to the setting description to capture this: https://github.com/neo-technology/neo4j/pull/28957

@jackwaudby jackwaudby changed the title Add seed restore until section Add seed restore until section and remove 5.x seed provider info Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nick-giles-neo nick-giles-neo nick-giles-neo left review comments

@NataliaIvakina NataliaIvakina NataliaIvakina left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@NataliaIvakina NataliaIvakina

Labels
clustering Cypher 25 dev
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@jackwaudby @neo-technology-commit-status-publisher @NataliaIvakina @nick-giles-neo @renetapopova