Skip to content

Commit cefed4a

Browse files
Restructure the section on how to administer composite db (#1586) (#1625)
Co-authored-by: Reneta Popova <[email protected]>
1 parent 0eff1c0 commit cefed4a

17 files changed

+90
-91
lines changed

modules/ROOT/content-nav.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,9 @@
118118
*** xref:database-administration/aliases/remote-database-alias-configuration.adoc[]
119119
** Composite databases
120120
*** xref:database-administration/composite-databases/concepts.adoc[]
121-
*** xref:database-administration/composite-databases/manage-composite-databases.adoc[]
121+
*** xref:database-administration/composite-databases/create-composite-databases.adoc[]
122+
*** xref:database-administration/composite-databases/list-composite-databases.adoc[]
123+
*** xref:database-administration/composite-databases/delete-composite-databases.adoc[]
122124
*** xref:database-administration/composite-databases/querying-composite-databases.adoc[]
123125
*** xref:database-administration/composite-databases/sharding-with-copy.adoc[]
124126
** xref:database-administration/syntax.adoc[]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ However, the command will output Cypher statements, which you can run to recreat
1313
====
1414
* `neo4j-admin database copy` preserves the node IDs (unless `--compact-node-store` is used), but the relationships get new IDs.
1515
* `neo4j-admin database copy` is not supported for use on the `system` database.
16-
* `neo4j-admin database copy` is not supported for use on xref:database-administration/composite-databases/manage-composite-databases.adoc[Composite databases].
16+
* `neo4j-admin database copy` is not supported for use on xref:database-administration/composite-databases/concepts.adoc[Composite databases].
1717
It must be run directly on the databases that are associated with that Composite database.
1818
* `neo4j-admin database copy` is an IOPS-intensive process.
1919
For more information, see <<copy-estimating-iops, Estimating the processing time>>.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,6 @@ bin/neo4j-admin database dump <database> --to-path=s3://full/path/to/aws-s3-dump
121121

122122
[NOTE]
123123
====
124-
`neo4j-admin database dump` cannot be applied to xref:database-administration/composite-databases/manage-composite-databases.adoc[Composite databases].
124+
`neo4j-admin database dump` cannot be applied to xref:database-administration/composite-databases/concepts.adoc[Composite databases].
125125
It must be run directly on the databases that are associated with that Composite database.
126126
====

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ The recommended way to restore a database in a cluster is to xref:clustering/dat
9696

9797
[NOTE]
9898
====
99-
The Neo4j Admin commands `backup`, `restore`, `dump`, `load`, `copy`, and `check-consistency` are not supported for use on xref:database-administration/composite-databases/manage-composite-databases.adoc[Composite databases].
99+
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].
100100
They must be run directly on the databases that are associated with that Composite database.
101101
====
102102

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

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

141141
[NOTE]
142142
====
143-
`neo4j-admin database load` cannot be applied to xref:database-administration/composite-databases/manage-composite-databases.adoc[Composite databases].
143+
`neo4j-admin database load` cannot be applied to xref:database-administration/composite-databases/concepts.adoc[Composite databases].
144144
It must be run directly on the databases that are associated with that Composite database.
145145
====

modules/ROOT/pages/configuration/neo4j-conf.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ In Neo4j 5, the `fabric` scope is no longer available.
6262
All configuration settings identified by the `fabric` namespace in the `neo4j.conf` file are moved into the `system` database.
6363
The Cypher surface is extended to support the Fabric configuration.
6464
65-
For more information, see xref:database-administration/composite-databases/manage-composite-databases.adoc[Composite databases].
65+
For more information, see xref:database-administration/composite-databases/concepts.adoc[Composite databases].
6666
====
6767
Component::
6868
Component namespaces are used to group settings that affect similar systems.

modules/ROOT/pages/database-administration/aliases/manage-aliases-composite-databases.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ For a description of all the returned columns of this command, and for ways in w
4949
[[create-composite-database-alias]]
5050
== Create database aliases in composite databases
5151

52-
Both local and remote database aliases can be part of a xref::database-administration/composite-databases/manage-composite-databases.adoc[composite database].
52+
Both local and remote database aliases can be part of a xref::database-administration/composite-databases/concepts.adoc[composite database].
5353

5454
The database alias is made of two parts, separated by a dot: the namespace and the alias name.
5555

modules/ROOT/pages/database-administration/aliases/manage-aliases-standard-databases.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ It is also possible to use `SKIP` and `LIMIT` to paginate the results.
235235

236236
Database aliases can be created using `CREATE ALIAS`.
237237
The command supports the creation of both local and remote database aliases.
238-
For more information on local and remote database aliases as part of a composite database, see xref::database-administration/composite-databases/manage-composite-databases.adoc#create-composite-database-alias[Create database aliases in composite databases].
238+
For more information on local and remote database aliases as part of a composite database, see xref::database-administration/aliases/manage-aliases-composite-databases.adoc#create-composite-database-alias[Create database aliases in composite databases].
239239

240240
The required privileges are described in the xref:authentication-authorization/dbms-administration.adoc#access-control-dbms-administration-alias-management[The DBMS ALIAS MANAGEMENT privileges].
241241

modules/ROOT/pages/database-administration/composite-databases/manage-composite-databases.adoc renamed to modules/ROOT/pages/database-administration/composite-databases/create-composite-databases.adoc

Lines changed: 6 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,23 @@
1-
:description: This page describes how to manage composite databases.
1+
:description: This page describes how to create, start, and stop composite databases.
22
:page-aliases: fabric/configuration.adoc
33
[role=enterprise-edition not-on-aura]
4-
[[composite-databases]]
5-
= Managing composite databases
4+
[[manage-composite-databases]]
5+
= Create, start, and stop composite databases
66

77
Composite databases are managed using Cypher(R) administrative commands.
88
Note that it is not possible to modify access options or database topologies for composite databases as these are inherited from the constituent databases.
99
For information about modifying access options, see xref:database-administration/standard-databases/alter-databases.adoc#manage-databases-alter[Alter database access mode].
1010
For information about about topologies for databases, see xref:clustering/setup/deploy.adoc#cluster-example-create-databases-on-cluster[Create databases in a cluster].
11-
// The above two links will have to be changed when server management and access control sections are migrated from Cypher Manual.
1211

13-
[[composite-databases-list]]
14-
== Listing composite databases
15-
16-
////
17-
[source, cypher, role=test-setup]
18-
----
19-
CREATE COMPOSITE DATABASE `library`;
20-
CREATE DATABASE `sci-fi`;
21-
CREATE ALIAS `library`.`sci-fi` FOR DATABASE `sci-fi`;
22-
----
23-
////
24-
25-
The `type` column returned by the `SHOW DATABASES` command will display which databases are composite databases.
26-
27-
.Query
28-
[source, cypher]
29-
----
30-
SHOW DATABASES
31-
----
32-
33-
.Result
34-
[role="queryresult"]
35-
----
36-
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
37-
| name | type | aliases | access | address | role | writer | requestedStatus | currentStatus | statusMessage | default | home | constituents |
38-
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
39-
| "library" | "composite" | [] | "read-only" | "localhost:7687" | NULL | FALSE | "online" | "online" | "" | FALSE | FALSE | ["library.sci-fi"] |
40-
| "neo4j" | "standard" | [] | "read-write" | "localhost:7687" | "primary" | TRUE | "online" | "online" | "" | TRUE | TRUE | [] |
41-
| "sci-fi" | "standard" | ["library.sci-fi"] | "read-write" | "localhost:7687" | "primary" | TRUE | "online" | "online" | "" | FALSE | FALSE | [] |
42-
| "system" | "system" | [] | "read-write" | "localhost:7687" | "primary" | TRUE | "online" | "online" | "" | FALSE | FALSE | [] |
43-
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
44-
----
45-
46-
For a description of all the returned column of this command, ways in which the `SHOW DATABASE` command can be filtered, and details about the privileges required for the command, see xref:database-administration/standard-databases/listing-databases.adoc#manage-databases-list[listing standard databases].
47-
48-
For composite databases, the `constituents` column is particularly interesting as it lists the aliases that make up the composite database.
49-
50-
.Query
51-
[source, cypher]
52-
----
53-
SHOW DATABASE library YIELD name, constituents
54-
----
55-
56-
.Result
57-
[role="queryresult"]
58-
----
59-
+--------------------------------+
60-
| name | constituents |
61-
+--------------------------------+
62-
| "library" | ["library.sci-fi"] |
63-
+--------------------------------+
64-
----
12+
Drivers and client applications connect to composite databases just like standard databases.
13+
For more information, see the manuals for the different link:{neo4j-docs-base-uri}/create-applications/[Neo4j drivers and applications].
6514

6615
[[composite-databases-create]]
6716
== Create a composite database
6817

6918
Composite databases can be created using `CREATE COMPOSITE DATABASE`.
7019

71-
Composite database names are subject to the same rules as xref:administration-databases-create-database[standard databases].
20+
Composite database names are subject to the same rules as xref:database-administration/standard-databases/naming-databases.adoc[standard databases].
7221
One difference is however that the deprecated syntax using dots without enclosing the name in backticks is not available.
7322
Both dots and dashes need to be enclosed within backticks when using composite databases.
7423

@@ -211,23 +160,3 @@ SHOW DATABASE inventory YIELD name, requestedStatus, currentStatus
211160
| "inventory" | "online" | "online" |
212161
+-----------------------------------------------+
213162
----
214-
215-
[[composite-databases-delete]]
216-
== Delete composite databases
217-
218-
Composite databases can be deleted using the command `DROP COMPOSITE DATABASE name`.
219-
This command will fail if the targeted database is not a composite database.
220-
221-
.Query
222-
[source, cypher]
223-
----
224-
DROP COMPOSITE DATABASE inventory
225-
----
226-
227-
It is also possible to use the shorter command `DROP DATABASE name` for composite databases, but this command will drop any database and not fail in case the targeted database is not a composite database.
228-
229-
[[composite-databases-drivers]]
230-
== Drivers and applications
231-
232-
Drivers and client applications connect to Composite databases just like standard databases.
233-
For more information, see the manuals for the different link:{neo4j-docs-base-uri}/create-applications/[Neo4j drivers and applications].
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
:description: This page describes how to delete composite databases.
2+
[role=enterprise-edition not-on-aura]
3+
[[composite-databases-delete]]
4+
= Delete composite databases
5+
6+
You can delete composite databases using either the command `DROP COMPOSITE DATABASE name` or the more general one `DROP DATABASE name`.
7+
However, keep in mind that the first command will fail if the target database is not composite, while the second one will not fail because it targets any database.
8+
9+
.Query
10+
[source, cypher]
11+
----
12+
DROP COMPOSITE DATABASE inventory
13+
----
14+

0 commit comments

Comments
 (0)