Skip to content

Commit 0eb4f25

Browse files
renetapopovarenetapopova
authored
Restructuring and rewording composite databases (#629) (#703)
Cherry-picked from #629
1 parent 4ccc3b2 commit 0eb4f25

23 files changed

+283
-215
lines changed

‎modules/ROOT/content-nav.adoc‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,9 @@
7474
** xref:manage-databases/errors.adoc[]
7575
** xref:manage-databases/remote-alias.adoc[]
7676
** xref:composite-databases/index.adoc[]
77-
*** xref:composite-databases/introduction.adoc[]
78-
*** xref:composite-databases/queries.adoc[]
77+
*** xref:composite-databases/administration.adoc[]
7978
*** xref:composite-databases/sharding-with-copy.adoc[]
80-
*** xref:composite-databases/considerations.adoc[]
79+
*** xref:composite-databases/queries.adoc[]
8180
8281
* xref:clustering/index.adoc[]
8382
** xref:clustering/introduction.adoc[]

‎modules/ROOT/images/federation-sharding.png‎

49.5 KB
Loading

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ 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:composite-databases/introduction.adoc#composite-databases-concepts[composite databases].
17-
It must be run directly on the databases that are part of a composite database.
16+
* `neo4j-admin database copy` is not supported for use on xref:composite-databases/index.adoc[Composite databases].
17+
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>>.
2020
====
@@ -60,7 +60,7 @@ The command will replace the original database with the newly created copy.
6060

6161
* `<fromDatabase>` -- Name of the source database.
6262

63-
* `<toDatabase>` -- Name of the target database.
63+
* `<toDatabase>` -- Name of the target database.
6464
If the same as `<fromDatabase>`, it is copied to a temporary location, by default the current working directory or the path as defined by `--temp-path`, before being moved to replace the original.
6565

6666
[[copy-database-command-options]]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,6 @@ bin/neo4j-admin database dump neo4j --to-path=/dumps/neo4j
8787

8888
[NOTE]
8989
====
90-
`neo4j-admin database dump` cannot be applied to xref:composite-databases/introduction.adoc#composite-databases-concepts[composite databases].
91-
It must be run directly on the databases that are part of a composite database.
90+
`neo4j-admin database dump` cannot be applied to xref:composite-databases/index.adoc[Composite databases].
91+
It must be run directly on the databases that are associated with that Composite database.
9292
====

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@ 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:composite-databases/introduction.adoc#composite-databases-concepts[composite databases].
100-
They must be run directly on the databases that are part of a composite database.
99+
The Neo4j Admin commands `backup`, `restore`, `dump`, `load`, `copy`, and `check-consistency` are not supported for use on xref:composite-databases/index.adoc[Composite databases].
100+
They must be run directly on the databases that are associated with that Composite database.
101101
====
102102

103103
.The following table describes the commands' capabilities and usage.
@@ -133,7 +133,7 @@ They must be run directly on the databases that are part of a composite database
133133
| {check-mark}
134134
| {cross-mark}
135135

136-
| Run against a composite databases
136+
| Run against a Composite databases
137137
| {cross-mark}
138138
| {cross-mark}
139139
| {cross-mark}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,6 @@ For more information, see xref:clustering/databases.adoc#cluster-seed[Seed a clu
121121

122122
[NOTE]
123123
====
124-
`neo4j-admin database load` cannot be applied to xref:composite-databases/introduction.adoc#composite-databases-concepts[composite databases].
125-
It must be run directly on the databases that are part of a composite database.
124+
`neo4j-admin database load` cannot be applied to xref:composite-databases/index.adoc[Composite databases].
125+
It must be run directly on the databases that are associated with that Composite database.
126126
====

‎modules/ROOT/pages/clustering/monitoring/show-databases-monitoring.adoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This node is either the leader for this database in a cluster _or_ this is a sta
3434
| statusMessage | String | A message explaining the current state of the database, which could be an error encountered by the Neo4j server when transitioning the database to `requestedStatus`, if any.
3535
| default | Boolean | Whether this database is the default for this DBMS.
3636
| home | Boolean | Whether this database is the home database for this user.
37-
| constituents | List<String> | A list of alias names making up this composite database, null for non-composite databases.
37+
| constituents | List<String> | A list of alias names making up this Composite database, null for non-Composite databases.
3838
|===
3939

4040
Note that for failed databases, `currentStatus` and `requestedStatus` are different.
@@ -46,7 +46,7 @@ For example:
4646

4747
The possible statuses are `initial`, `offline`, `store copying`, `deallocating`, `unknown`, `dirty`, and `quarantined`.
4848

49-
Additionally, note that databases hosted on servers that are offline are also returned by the `SHOW DATABASES` command.
49+
Additionally, note that databases hosted on servers that are offline are also returned by the `SHOW DATABASES` command.
5050
For such databases the `address` column displays `NULL`, the `currentStatus` column displays `unknown`, and the `statusMessage` displays `Server is unavailable`.
5151

5252
.Listing databases in standalone Neo4j
@@ -142,7 +142,7 @@ This node is either the leader for this database in a cluster _or_ this is a sta
142142
| statusMessage | String | A message explaining the current state of the database, which could be an error encountered by the Neo4j server when transitioning the database to `requestedStatus`, if any.
143143
| default | Boolean | Whether this database is the default for this DBMS.
144144
| home | Boolean | Whether this database is the home database for this user.
145-
| constituents | List<String> | A list of alias names making up this composite database, null for non-composite databases.
145+
| constituents | List<String> | A list of alias names making up this Composite database, null for non-Composite databases.
146146
|===
147147

148148
.Listing statuses for database _foo_
@@ -208,5 +208,5 @@ It is the same as creation time unless the database has been stopped at some poi
208208
May be different between members when changes have not propagated. | 2342
209209
| `replicationLag` | Integer | The difference in transaction numbers between this server and the writer of this database.
210210
If this is persistently high, there may be a problem. | 1
211-
| `constituents` | List<String> | A list of alias names making up this composite database, null for non-composite databases. | "[]"
211+
| `constituents` | List<String> | A list of alias names making up this Composite database, null for non-Composite databases. | "[]"
212212
|===

‎modules/ROOT/pages/clustering/servers.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Server tags are used during database allocation and when configuring load balanc
132132

133133
[NOTE]
134134
====
135-
`allowedDatabases` and `deniedDatabases` do not affect composite databases, they are always available everywhere.
135+
`allowedDatabases` and `deniedDatabases` do not affect Composite databases, they are always available everywhere.
136136
====
137137

138138
If no options are set, a server can host any database in any mode.
@@ -255,7 +255,7 @@ For a description of all the server options (e.g., server tags) that can be alte
255255

256256
[NOTE]
257257
====
258-
`allowedDatabases` and `deniedDatabases` do not affect composite databases, they are always available everywhere.
258+
`allowedDatabases` and `deniedDatabases` do not affect Composite databases, they are always available everywhere.
259259
====
260260

261261
As with the `DEALLOCATE DATABASES FROM SERVER ...` command, if the alteration of a server's options renders it impossible for the cluster to satisfy one or more of the databases' topologies, then the command fails and no changes are made.

‎modules/ROOT/pages/composite-databases/administration.adoc‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
:description: This section describes the administration and operation of Composite databases.
2+
[role=enterprise-edition]
3+
[[composite-databases-administration]]
4+
= Managing Composite databases
5+
6+
Composite databases are managed using administrative commands.
7+
They are created with the link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/databases#administration-databases-create-composite-database[`CREATE COMPOSITE DATABASE`^] command.
8+
9+
== Create a Composite database
10+
11+
====
12+
[source, cypher]
13+
----
14+
CREATE COMPOSITE DATABASE cineasts
15+
----
16+
====
17+
18+
Constituent graphs are added with the link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/aliases#alias-management-create-database-alias[`CREATE ALIAS`^] administrative command, for example:
19+
20+
== Create an alias on a Composite database
21+
22+
====
23+
[source, cypher]
24+
----
25+
CREATE ALIAS cineasts.latest
26+
FOR DATABASE movies2022
27+
----
28+
====
29+
30+
Aliases can also be created for databases on other DBMSs:
31+
32+
== Create an alias for a remote database on a Composite database
33+
34+
====
35+
[source, cypher]
36+
----
37+
CREATE ALIAS cineasts.upcoming
38+
FOR DATABASE upcoming
39+
AT 'neo4j+s://other.dbms.com'
40+
USER $user
41+
PASSWORD $secretpassword
42+
----
43+
====
44+
45+
The link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/databases#administration-databases-show-databases[`SHOW DATABASE`^] administrative command includes Composite databases.
46+
47+
Their `type` is reported as `"composite"`, and the `constituents` column lists the names of the aliases contained.
48+
49+
== Show a Composite database
50+
51+
====
52+
[source, cypher]
53+
----
54+
SHOW DATABASE cineasts YIELD name, type, constituents
55+
----
56+
----
57+
+---------------------------------------------------------------------+
58+
| name | type | constituents |
59+
+---------------------------------------------------------------------+
60+
| "cineasts" | "composite" | ["cineasts.latest", "cineasts.upcoming"] |
61+
+---------------------------------------------------------------------+
62+
63+
----
64+
====
65+
66+
67+
The link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/aliases#alias-management-show-alias[`SHOW ALIASES FOR DATABASE`^] administrative command can be used to inspect aliases on Composite databases in further detail.
68+
69+
== Show Composite database aliases
70+
71+
====
72+
[source, cypher]
73+
----
74+
SHOW ALIASES FOR DATABASE
75+
----
76+
----
77+
+----------------------------------------------------------------------------------------+
78+
| name | database | location | url | user |
79+
+----------------------------------------------------------------------------------------+
80+
| "cineasts.latest" | "movies2022" | "local" | NULL | NULL |
81+
| "cineasts.upcoming" | "upcoming" | "remote" | "neo4j+s://other.dbms.com" | "cineast" |
82+
+----------------------------------------------------------------------------------------+
83+
----
84+
====
85+
86+
For a full description of the administrative commands for managing Composite databases, see link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/databases[Cypher Manual -> Database management^].
87+
88+
89+
[[composite-databases-connecting]]
90+
== Connect to drivers and applications
91+
92+
Drivers and client applications connect to Composite databases just like standard databases.
93+
For more information, see the respective link:{neo4j-docs-base-uri}/[Neo4j Driver manual^].

‎modules/ROOT/pages/composite-databases/considerations.adoc‎

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)