Remove useExisting option; polish examples & page
#2287
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This PR includes documentation updates Updated pages: |
renetapopova
requested changes
Apr 25, 2025
| ---- | ||
|
|
||
| Download and validation of the seed is only performed as the new database is started. | ||
| If it fails, the database is not available and it has the `statusMessage`: `Unable to start database` of the `SHOW DATABASES` command. | ||
|
|
||
| [source, cypher, role="noplay"] | ||
| [source, cypher] | ||
| ---- | ||
| neo4j@neo4j> SHOW DATABASES; |
There was a problem hiding this comment.
Suggested change
| neo4j@neo4j> SHOW DATABASES; | |
| SHOW DATABASES; | |
| ---- |
| ---- | ||
|
|
||
| Download and validation of the seed is only performed as the new database is started. | ||
| If it fails, the database is not available and it has the `statusMessage`: `Unable to start database` of the `SHOW DATABASES` command. | ||
|
|
||
| [source, cypher, role="noplay"] | ||
| [source, cypher] | ||
| ---- | ||
| neo4j@neo4j> SHOW DATABASES; | ||
| +---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
There was a problem hiding this comment.
Suggested change
| +---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |
| .Example output | |
| [result] | |
| ---- | |
| +---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| @@ -55,6 +55,9 @@ The `FileSeedProvider` supports: | |||
|
|
|||
| ** `file:` | |||
|
|
|||
| [NOTE] | |||
There was a problem hiding this comment.
Suggested change
| [NOTE] | |
| [NOTE] | |
| ==== |
| @@ -55,6 +55,9 @@ The `FileSeedProvider` supports: | |||
|
|
|||
| ** `file:` | |||
|
|
|||
| [NOTE] | |||
| Local file paths must be absolute paths. | |||
There was a problem hiding this comment.
Suggested change
| Local file paths must be absolute paths. | |
| Local file paths must be absolute paths. | |
| ==== |
| @@ -200,7 +215,7 @@ Where `accessKey` and `secretKey` are provided by AWS. | |||
|
|
|||
| | `file:` | |||
| | `FileSeedProvider` | |||
| | `\file://tmp/backup1.backup` | |||
| | `\file:/tmp/backup1.backup` | |||
There was a problem hiding this comment.
Perhaps, you mean:
Suggested change
| | `\file:/tmp/backup1.backup` | |
| | `file:///tmp/backup1.backup` |
There was a problem hiding this comment.
No, what I wrote is correct. What you wrote is also correct. Both work. I wrote that one because triple slashes are more cumbersome that single slashes.
The only thing that doesn't work is the one that's currently documented 😅
| ---- | ||
| CREATE DATABASE foo OPTIONS {existingData: 'use', seedURI:'s3://myBucket/myBackup.backup'} | ||
| CREATE DATABASE foo OPTIONS { seedURI:'s3://myBucket/myBackup.backup' } |
There was a problem hiding this comment.
I am not aware of existingData: 'use' being deprecated and it's not documented. I would suggest that the Clustering team review this PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This all started with me using this feature and noticing that the documented examples triggered a warning.
Digging further into the feature and thus the docs, I took the chance to polish examples (syntax highlighting, avoid scrolling) and a few wordings.