Skip to content

Commit 6e91050

Browse files
authored
Scalability docs (#2653)
1 parent ca614f7 commit 6e91050

40 files changed

+1420
-37
lines changed

modules/ROOT/content-nav.adoc

Lines changed: 35 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -130,25 +130,8 @@
130130
*** xref:database-administration/aliases/manage-aliases-standard-databases.adoc[]
131131
*** xref:database-administration/aliases/manage-aliases-composite-databases.adoc[]
132132
*** xref:database-administration/aliases/remote-database-alias-configuration.adoc[]
133-
** Composite databases
134-
*** xref:database-administration/composite-databases/concepts.adoc[]
135-
*** xref:database-administration/composite-databases/create-composite-databases.adoc[]
136-
*** xref:database-administration/composite-databases/list-composite-databases.adoc[]
137-
*** xref:database-administration/composite-databases/alter-composite-databases.adoc[]
138-
*** xref:database-administration/composite-databases/start-stop-composite-databases.adoc[]
139-
*** xref:database-administration/composite-databases/delete-composite-databases.adoc[]
140-
*** xref:database-administration/composite-databases/querying-composite-databases.adoc[]
141-
*** xref:database-administration/composite-databases/sharding-with-copy.adoc[]
142133
** xref:database-administration/routing-decisions.adoc[]
143134
144-
* xref:database-internals/index.adoc[]
145-
** xref:database-internals/transaction-management.adoc[]
146-
** xref:database-internals/concurrent-data-access.adoc[]
147-
** xref:database-internals/transaction-logs.adoc[]
148-
** xref:database-internals/checkpointing.adoc[]
149-
** xref:database-internals/store-formats.adoc[]
150-
** xref:database-internals/neo4j-admin-store-info.adoc[]
151-
152135
* xref:clustering/index.adoc[]
153136
** xref:clustering/introduction.adoc[]
154137
** Setting up a cluster
@@ -177,6 +160,41 @@
177160
** xref:clustering/server-syntax.adoc[]
178161
** xref:clustering/glossary.adoc[]
179162
163+
* Scalability
164+
** xref:scalability/concepts.adoc[]
165+
** xref:scalability/scaling-with-neo4j.adoc[]
166+
** Composite databases
167+
*** xref:scalability/composite-databases/concepts.adoc[]
168+
*** xref:scalability/composite-databases/create-composite-databases.adoc[]
169+
*** xref:scalability/composite-databases/list-composite-databases.adoc[]
170+
*** xref:scalability/composite-databases/alter-composite-databases.adoc[]
171+
*** xref:scalability/composite-databases/start-stop-composite-databases.adoc[]
172+
*** xref:scalability/composite-databases/delete-composite-databases.adoc[]
173+
*** xref:scalability/composite-databases/querying-composite-databases.adoc[]
174+
*** xref:scalability/composite-databases/sharding-with-copy.adoc[]
175+
//*** xref:scalability/composite-databases/scaling-with-composite-databases.adoc[]
176+
** Property sharding (Preview feature)
177+
*** xref:scalability/sharded-property-databases/overview.adoc[]
178+
*** xref:scalability/sharded-property-databases/planning-and-sizing.adoc[]
179+
*** xref:scalability/sharded-property-databases/configuration.adoc[]
180+
*** xref:scalability/sharded-property-databases/data-ingestion.adoc[]
181+
*** xref:scalability/sharded-property-databases/starting-stopping-sharded-databases.adoc[]
182+
*** xref:scalability/sharded-property-databases/listing-sharded-databases.adoc[]
183+
*** xref:scalability/sharded-property-databases/altering-sharded-databases.adoc[]
184+
*** xref:scalability/sharded-property-databases/deleting-sharded-databases.adoc[]
185+
*** xref:scalability/sharded-property-databases/role-based-access-control.adoc[]
186+
*** xref:scalability/sharded-property-databases/admin-operations.adoc[]
187+
*** xref:scalability/sharded-property-databases/security.adoc[]
188+
*** xref:scalability/sharded-property-databases/limitations-and-considerations.adoc[]
189+
190+
* xref:database-internals/index.adoc[]
191+
** xref:database-internals/transaction-management.adoc[]
192+
** xref:database-internals/concurrent-data-access.adoc[]
193+
** xref:database-internals/transaction-logs.adoc[]
194+
** xref:database-internals/checkpointing.adoc[]
195+
** xref:database-internals/store-formats.adoc[]
196+
** xref:database-internals/neo4j-admin-store-info.adoc[]
197+
180198
* xref:backup-restore/index.adoc[]
181199
** xref:backup-restore/planning.adoc[]
182200
** xref:backup-restore/modes.adoc[]

modules/ROOT/images/scalability/horizontal-scaling-strategies.svg

Lines changed: 82 additions & 0 deletions
Loading

modules/ROOT/images/scalability/property-shard-deployment.svg

Lines changed: 77 additions & 0 deletions
Loading

modules/ROOT/images/scalability/sharded-architecture.svg

Lines changed: 41 additions & 0 deletions
Loading

modules/ROOT/pages/backup-restore/consistency-checker.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ The following are examples of how to check the consistency of a database, a dump
141141

142142
[NOTE]
143143
====
144-
`neo4j-admin database check` cannot be applied to xref:database-administration/composite-databases/concepts.adoc[Composite databases].
144+
`neo4j-admin database check` cannot be applied to xref:scalability/composite-databases/concepts.adoc[Composite databases].
145145
It must be run directly on the databases that are associated with that Composite database.
146146
====
147147

modules/ROOT/pages/backup-restore/copy-database.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You can use the `neo4j-admin database copy` command to copy a database, create a
1111
====
1212
* `neo4j-admin database copy` preserves the node IDs (unless `--compact-node-store` is used), but the relationships get new IDs.
1313
* `neo4j-admin database copy` is not supported for use on the `system` database.
14-
* `neo4j-admin database copy` is not supported for use on xref:database-administration/composite-databases/concepts.adoc[Composite databases].
14+
* `neo4j-admin database copy` is not supported for use on xref:scalability/composite-databases/concepts.adoc[Composite databases].
1515
It must be run directly on the databases that are associated with that Composite database.
1616
* `neo4j-admin database copy` is an IOPS-intensive process.
1717
For more information, see <<copy-estimating-iops, Estimating the processing time>>.
@@ -300,7 +300,7 @@ Labels are processed independently, i.e., the filter ignores any node with a lab
300300

301301
[TIP]
302302
====
303-
For a detailed example of how to use `neo4j-admin database copy` to filter out data for sharding a database, see xref:database-administration/composite-databases/sharding-with-copy.adoc[Sharding data with the `copy` command].
303+
For a detailed example of how to use `neo4j-admin database copy` to filter out data for sharding a database, see xref:scalability/composite-databases/sharding-with-copy.adoc[Sharding data with the `copy` command].
304304
====
305305

306306
[[compact-database]]

modules/ROOT/pages/backup-restore/offline-backup.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ The command creates a file called _database.dump_ where `database` is the databa
109109

110110
[NOTE]
111111
====
112-
`neo4j-admin database dump` cannot be applied to xref:database-administration/composite-databases/concepts.adoc[Composite databases].
112+
`neo4j-admin database dump` cannot be applied to xref:scalability/composite-databases/concepts.adoc[Composite databases].
113113
It must be run directly on the databases that are associated with that Composite database.
114114
====
115115

modules/ROOT/pages/backup-restore/planning.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ The following table summarizes the commands' capabilities and usage.
172172

173173
[NOTE]
174174
====
175-
The Neo4j Admin commands `backup`, `restore`, `dump`, `load`, `copy`, and `check-consistency` are not supported for use on xref:database-administration/composite-databases/concepts.adoc[Composite databases].
175+
The Neo4j Admin commands `backup`, `restore`, `dump`, `load`, `copy`, and `check-consistency` are not supported for use on xref:scalability/composite-databases/concepts.adoc[Composite databases].
176176
They must be run directly on the databases that are associated with that Composite database.
177177
====
178178

@@ -196,7 +196,7 @@ By default, a database backup includes only the database contents.
196196
If you choose to include metadata, the backup also stores the role-based access control (RBAC) settings associated with the database.
197197
198198
When restoring, you have the flexibility to define the target topology (how many primaries and secondaries are desired for the database), which may differ from the topology at backup time.
199-
The database will then be allocated across the available servers according to that topology.
199+
The database will then be allocated across the available servers according to that topology.
200200
====
201201

202202
[[backup-planning-databases]]

modules/ROOT/pages/backup-restore/restore-dump.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ For more information, see xref:clustering/databases.adoc#cluster-seed[Seed a clu
117117

118118
[NOTE]
119119
====
120-
`neo4j-admin database load` cannot be applied to xref:database-administration/composite-databases/concepts.adoc[Composite databases].
120+
`neo4j-admin database load` cannot be applied to xref:scalability/composite-databases/concepts.adoc[Composite databases].
121121
It must be run directly on the databases that are associated with that Composite database.
122122
====
123123

modules/ROOT/pages/configuration/configuration-settings.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Refer to xref:configuration/neo4j-conf.adoc#_configuration_settings[The neo4j.co
88

99
For lists of deprecated and removed configuration settings in 2025.x, refer to the page xref:changes-deprecations-removals.adoc[Changes, deprecations, and removals in Neo4j 2025.x].
1010

11-
To list all available configuration settings on a Neo4j server, run the link:https://neo4j.com/docs/cypher-manual/5/clauses/listing-settings[`SHOW SETTINGS`] command.
11+
To list all available configuration settings on a Neo4j server, run the link:{neo4j-docs-base-uri}/cypher-manual/5/clauses/listing-settings[`SHOW SETTINGS`] command.
1212

1313

1414
== Dynamic configuration settings

0 commit comments

Comments
 (0)