Skip to content

Scalability docs #2653

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
Open
wants to merge 27 commits into
base: dev
Choose a base branch
from
Open

Scalability docs #2653

wants to merge 27 commits into from

Conversation

renetapopova
Copy link
Collaborator

No description provided.

@renetapopova renetapopova requested a review from izoratti October 10, 2025 20:02
@chamocarrot chamocarrot self-requested a review October 14, 2025 13:59
NataliaIvakina
NataliaIvakina reviewed Oct 16, 2025
View reviewed changes
ConorNeo
ConorNeo suggested changes Oct 16, 2025
View reviewed changes
modules/ROOT/pages/scalability/sharded-property-databases/admin-operations.adoc Outdated
If a property shard replica does fall behind the transaction log range available on the graph shard, you can recover it by:

. Connecting to the server hosting the affected replica using the _bolt://_ scheme.
. Quarantining the replica using xref:procedures.adoc#procedure_dbms_quarantineDatabase[`dbms.quarantineDatabase()`].
Copy link
Contributor

Choose a reason for hiding this comment

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

This procedure is deprecated, and will be replaced with something else before GA, not sure if we want to mention here or just update it when its fixed.

Copy link
Contributor

Choose a reason for hiding this comment

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

Also either way you will need to prefix it with CYPHER 5 so we should add that to the command

Copy link
Collaborator

Choose a reason for hiding this comment

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

@ConorNeo, hi! I don't want to confuse anyone, but we were told some time ago that the dbms.unquarantineDatabase() procedure replaces the deprecated dbms.quarantineDatabase(). We state this in the docs -- see https://neo4j.com/docs/operations-manual/current/database-administration/standard-databases/errors/#quarantine and the note below https://neo4j.com/docs/operations-manual/current/procedures/#procedure_dbms_quarantineDatabase.

I found this PR https://github.com/neo-technology/neo4j/pull/27709. This might be helpful.

I'm not sure if there is a plan to introduce any new procedure instead of quarantineDatabase. It seems it has got its replacement already.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, that's true. As far as I know, when an error occurs, Neo4j stops the database and places it in a quarantined state, but I am not sure how this works on a replica.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah i confirmed this with the cluster team and we will replace it before we go GA :)

Copy link
Collaborator Author

@renetapopova renetapopova Oct 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@ConorNeo, It is commented out. Should I uncomment it?

chamocarrot
chamocarrot reviewed Oct 17, 2025
View reviewed changes
@renetapopova renetapopova marked this pull request as ready for review October 20, 2025 15:50
@renetapopova
more content and suggestions from PM
12e7fc5
@renetapopova
add sizing and some of the dataingestion content
98f8dbf
@renetapopova
update the planning the topology section
d690d44
@renetapopova
added the rest of data ingestion, starting and stopping, listing
fd2f472
@renetapopova
fix the listing output
f0e6f71
@renetapopova
add altering sharded property databases
f9bd98a
@renetapopova
apply suggestion from review
7d604df
@renetapopova
add deleting sharded property databases
8a90ed7
@renetapopova
last batch of content
7c459be
@renetapopova
placeholders for diagrams
82e6530
@renetapopova
add the files
e5a8cb0
@renetapopova
editorial updates
beceaf6
@renetapopova
update the sizing section
1e5bf5e
@renetapopova
further updates
e1ad631
@renetapopova
update the planning page
7572cf1
@renetapopova
remove other mentions of autonomous
49a277d
@renetapopova
editorial updates
651ef26
@renetapopova
apply suggestions from review
b870dcd
@renetapopova
remove internal.dbms.single_raft_enabled=true
e917639
@renetapopova
comment out the unlimited growth of a graph
a7a51aa
@renetapopova
Update the table with the scalability options
26ec09e
@renetapopova
add the diagrams and some editorial updates
762f38f
@renetapopova
small update
b78c8fe
@renetapopova
apply suggestions from review
46b8d8b
@renetapopova
update the show databases output table
c3266b9
@neo4j-docops-agent
Copy link
Collaborator

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

New pages:

Updated pages:

@renetapopova
Copy link
Collaborator Author

The failing test is not related to this PR.

ConorNeo
ConorNeo approved these changes Oct 22, 2025
View reviewed changes
Copy link
Contributor

@ConorNeo ConorNeo left a comment

Choose a reason for hiding this comment

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

Happy from the Engineering side! :) we have things to add but will do it in a follow PR for the next release!

Thanks for alll your hard work these are great!

modules/ROOT/pages/scalability/sharded-property-databases/admin-operations.adoc Outdated
If a property shard replica does fall behind the transaction log range available on the graph shard, you can recover it by:

. Connecting to the server hosting the affected replica using the _bolt://_ scheme.
. Quarantining the replica using xref:procedures.adoc#procedure_dbms_quarantineDatabase[`dbms.quarantineDatabase()`].
Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah i confirmed this with the cluster team and we will replace it before we go GA :)

chamocarrot
chamocarrot reviewed Oct 23, 2025
View reviewed changes
modules/ROOT/pages/scalability/sharded-property-databases/configuration.adoc
| Ensures that any database created will use Cypher 25 (unless users specifically override the default version in the `CREATE DATABASE` command).
See xref:configuration/cypher-version-configuration.adoc[Configure the Cypher default version] and link:https://neo4j.com/docs/cypher-manual/25/queries/select-version/[Cypher Manual -> Select Cypher version].

| internal.dbms.cluster.experimental_protocol_version.dbms_enabled=true
Copy link
Collaborator

Choose a reason for hiding this comment

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

Remove this parameter as it is not needed anymore.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@chamocarrot chamocarrot chamocarrot left review comments

@NataliaIvakina NataliaIvakina NataliaIvakina left review comments

@sstefano69 sstefano69 Awaiting requested review from sstefano69

@izoratti izoratti Awaiting requested review from izoratti

+2 more reviewers

@davidfauth davidfauth davidfauth left review comments

@ConorNeo ConorNeo ConorNeo approved these changes

Reviewers whose approvals may not affect merge requirements

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

Assignees

No one assigned

Labels

2025.10

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@renetapopova @neo4j-docops-agent @davidfauth @izoratti @chamocarrot @NataliaIvakina @ConorNeo